summaryrefslogtreecommitdiff
path: root/tor-chanmgr/README.md
blob: 3b0962a2bfb1cd952d1c7b2793636fdae610e706 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# tor-chanmgr

`tor-chanmgr`: Manage a set of channels on the Tor network.

## Overview

This crate is part of
[Arti](https://gitlab.torproject.org/tpo/core/arti/), a project to
implement [Tor](https://www.torproject.org/) in Rust.

In Tor, a Channel is a connection to a Tor relay.  It can be
direct via TLS, or indirect via TLS over a pluggable transport.
(For now, only direct channels are supported.)

Since a channel can be used for more than one circuit, it's
important to reuse channels when possible.  This crate implements
a [`ChanMg`r] type that can be used to create channels on demand,
and return existing channels when they already exist.

License: MIT OR Apache-2.0