Struct PtMgr

pub struct PtMgr<R> {
    pub(crate) runtime: R,
    pub(crate) state: Arc<RwLock<PtSharedState>>,
    pub(crate) tx: UnboundedSender<PtReactorMessage>,
}

A pluggable transport manager knows how to make different kinds of connections to the Tor network, for censorship avoidance.

Fields

runtime: R

An underlying Runtime, used to spawn background tasks.

state: Arc<RwLock<PtSharedState>>

State for this PtMgr that’s shared with the PtReactor.

tx: UnboundedSender<PtReactorMessage>

Available on crate feature managed-pts only.

PtReactor channel when the managed-pts feature is enabled.

Implementations

impl<R: Runtime> PtMgr<R>

pub(crate) fn transform_config( binaries: Vec<TransportConfig>, ) -> Result<HashMap<PtTransportName, TransportOptions>, Bug>

Transform the config into a more useful representation indexed by transport name.

pub fn new( transports: Vec<TransportConfig>, state_dir: PathBuf, path_resolver: Arc<CfgPathResolver>, rt: R, ) -> Result<Self, PtError>

Create a new PtMgr.

pub fn reconfigure( &self, how: Reconfigure, transports: Vec<TransportConfig>, ) -> Result<(), ReconfigureError>

Reload the configuration

pub(crate) async fn get_cmethod_for_transport( &self, transport: &PtTransportName, ) -> Result<Option<PtClientMethod>, PtError>

Available on crate feature tor-channel-factory only.

Given a transport name, return a method that we can use to contact that transport.

May have to launch a managed transport as needed.

Returns Ok(None) if no such transport exists.

pub(crate) async fn spawn_transport( &self, transport: &PtTransportName, ) -> Result<PtClientMethod, PtError>

Available on crate features tor-channel-factory and managed-pts only.

Communicate with the PT reactor to launch a managed transport.

Trait Implementations

impl<R: Runtime> AbstractPtMgr for PtMgr<R>

Available on crate feature tor-channel-factory only.

fn factory_for_transport<'life0, 'life1, 'async_trait>( &'life0 self, transport: &'life1 PtTransportName, ) -> Pin<Box<dyn Future<Output = Result<Option<Arc<dyn ChannelFactory + Send + Sync>>, Arc<dyn AbstractPtError>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get a ChannelFactory for the provided PtTransportName.