Expand description
This module contains a WIP relay tunnel reactor.
The initial version will duplicate some of the logic from the client tunnel reactor.
TODO(relay): refactor the relay tunnel to share the same base tunnel implementation as the client tunnel (to reduce code duplication).
See the design notes at doc/dev/notes/relay-reactor.md
Modules§
- channel 🔒
- Relay channel code.
- channel_
provider - Module exposing the
ChannelProvidertrait. - reactor 🔒
- Module exposing the relay circuit reactor subsystem.
Structs§
- Circ
NetParameters - Network consensus parameters for handling incoming circuits.
- Circuit
Incoming Stream Receiver - A receiver of
Streams (one for each incoming circuit), where eachStreamproducesIncomingStreams for that circuit. - Congestion
Control NetParams - Congestion control network parameters.
- Create
Request Handler - Everything needed to handle CREATE* messages on channels.
- Relay
Circ - A handle for interacting with a relay circuit.
Enums§
- Maybe
Verifiable Relay Responder Channel - An enum combining both the possibility of a verifiable (relay) or non verifiable channel (client/bridge).
- Relay
Circ 🔒Chan Msg - A subclass of ChanMsg that can correctly arrive on a live relay circuit (one where a CREATE* has been received).
Traits§
- Incoming
Stream Request Filter Factory - An
IncomingStreamRequestFilterfactory for buildingIncomingStreamRequestFilters.