History

Nick Mathewson 7ef9dde99c Merge branch 'todos-chanmgr' into 'main' chanmgr: resolve several remaining "TODO pt-client" issues See merge request tpo/core/arti!897		2022-11-29 19:31:48 +00:00
..
src	Merge branch 'todos-chanmgr' into 'main'	2022-11-29 19:31:48 +00:00
Cargo.toml	Mark set-default-factory API as experimental.	2022-11-23 11:10:34 -05:00
README.md	chanmgr: Make "pt-client" non-experimental.	2022-11-18 08:53:47 -05:00
semver.md	Have ChannelBuilder use TransportHelper.	2022-10-13 08:36:05 -04:00

README.md

tor-chanmgr

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

Overview

This crate is part of Arti, a project to implement Tor 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 [ChanMgr] type that can be used to create channels on demand, and return existing channels when they already exist.

Compile-time features

pt-client -- Build with APIs to support pluggable transports.

Experimental and unstable features

Note that the APIs enabled by these features are NOT covered by semantic versioning¹ guarantees: we might break them or remove them between patch versions.

experimental -- Build with all experimental features above. (Currently, there are no experimental features in this crate, but there may be some in the future.)

License: MIT OR Apache-2.0

Remember, semantic versioning is what makes various cargo features work reliably. To be explicit: if you want cargo update to only make safe changes, then you cannot enable these features. ↩︎