Skip to main content

Module relay

Module relay 

Source
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

Re-exportsยง

pub use channel::MaybeVerifiableRelayResponderChannel;
pub use channel::create_handler::CircNetParameters;
pub use channel::create_handler::CircuitIncomingStreamReceiver;
pub use channel::create_handler::CongestionControlNetParams;
pub use channel::create_handler::CreateRequestHandler;
pub use channel::create_handler::IncomingStreamRequestFilterFactory;
use derive_deftly::Deftly; ๐Ÿ”’
use oneshot_fused_workaround as oneshot; ๐Ÿ”’
use tor_cell::chancell::msg as chanmsg; ๐Ÿ”’
use tor_cell::relaycell::StreamId; ๐Ÿ”’
use tor_cell::relaycell::flow_ctrl::XonKBpsEwma; ๐Ÿ”’
use tor_memquota::derive_deftly_template_HasMemoryCost; ๐Ÿ”’
use crate::Error; ๐Ÿ”’
use crate::circuit::celltypes::derive_deftly_template_RestrictedChanMsgSet; ๐Ÿ”’
use crate::circuit::reactor::CircReactorHandle; ๐Ÿ”’
use crate::circuit::reactor::CtrlCmd; ๐Ÿ”’
use crate::circuit::reactor::backward; ๐Ÿ”’
use crate::circuit::reactor::forward; ๐Ÿ”’
use crate::relay::reactor::backward::Backward; ๐Ÿ”’
use crate::relay::reactor::forward::Forward; ๐Ÿ”’
use crate::stream::incoming::IncomingStreamRequestFilter; ๐Ÿ”’
use crate::stream::StreamTarget; ๐Ÿ”’

Modulesยง

channel ๐Ÿ”’
Relay channel code.
channel_provider
Module exposing the ChannelProvider trait.
reactor ๐Ÿ”’
Module exposing the relay circuit reactor subsystem.

Structsยง

RelayCirc
A handle for interacting with a relay circuit.

Enumsยง

RelayCircChanMsg ๐Ÿ”’
A subclass of ChanMsg that can correctly arrive on a live relay circuit (one where a CREATE* has been received).