History

eta 118050e54c Merge branch 'test-lints' into 'main' Add test lint blocks to all "mod test" See merge request tpo/core/arti!937		2023-01-06 17:16:09 +00:00
..
src	test lint blocks: Add many many automatically	2022-12-12 18:00:30 +00:00
Cargo.toml	Bump the minor version of every crate.	2022-11-30 15:10:16 -05:00
README.md	doc: consistent summary line for the READMEs	2022-12-20 14:31:47 +01:00

README.md

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. ↩︎