Struct AbstractChanMgr

pub(crate) struct AbstractChanMgr<CF: AbstractChannelFactory> {
    pub(crate) channels: MgrState<CF>,
    pub(crate) reporter: BootstrapReporter,
    pub(crate) memquota: ToplevelAccount,
}

A type- and network-agnostic implementation for ChanMgr.

This type does the work of keeping track of open channels and pending channel requests, launching requests as needed, waiting for pending requests, and so forth.

The actual job of launching connections is deferred to an AbstractChannelFactory type.

Fields

channels: MgrState<CF>

All internal state held by this channel manager.

The most important part is the map from relay identity to channel, or to pending channel status.

reporter: BootstrapReporter

A bootstrap reporter to give out when building channels.

memquota: ToplevelAccount

The memory quota account that every channel will be a child of

Implementations

impl<CF: AbstractChannelFactory + Clone> AbstractChanMgr<CF>

pub(crate) fn new( connector: CF, config: &ChannelConfig, dormancy: Dormancy, netparams: &NetParameters, reporter: BootstrapReporter, memquota: ToplevelAccount, ) -> Self

Make a new empty channel manager.

pub(crate) fn with_mut_builder<F>(&self, func: F)

where F: FnOnce(&mut CF),

Run a function to modify the channel builder in this object.

pub(crate) async fn handle_incoming( &self, src: SocketAddr, stream: CF::Stream, ) -> Result<Arc<CF::Channel>>

Available on crate feature relay only.

Build a channel for an incoming stream. See ChanMgr::handle_incoming.

pub(crate) async fn get_or_launch( &self, target: CF::BuildSpec, usage: ChannelUsage, ) -> Result<(Arc<CF::Channel>, ChanProvenance)>

Get a channel corresponding to the identities of target.

If a usable channel exists with that identity, return it.

If no such channel exists already, and none is in progress, launch a new request using target.

If no such channel exists already, but we have one that’s in progress, wait for it to succeed or fail.

async fn get_or_launch_internal( &self, target: CF::BuildSpec, ) -> Result<(Arc<CF::Channel>, ChanProvenance)>

Get a channel whose identity is ident - internal implementation

fn choose_action( &self, target: &CF::BuildSpec, final_attempt: bool, ) -> Result<Option<Action<CF::Channel>>>

Helper: based on our internal state, decide which action to take when asked for a channel, and update our internal state accordingly.

If final_attempt is true, then we will not pick any action that does not result in an immediate result. If we would pick such an action, we instead return Ok(None). (We could instead have the caller detect such actions, but it’s less efficient to construct them, insert them, and immediately revert them.)

pub(crate) fn update_netparams( &self, netparams: Arc<dyn AsRef<NetParameters>>, ) -> StdResult<(), Bug>

Update the netdir

pub(crate) fn set_dormancy( &self, dormancy: Dormancy, netparams: Arc<dyn AsRef<NetParameters>>, ) -> StdResult<(), Bug>

Notifies the chanmgr to be dormant like dormancy

pub(crate) fn reconfigure( &self, config: &ChannelConfig, netparams: Arc<dyn AsRef<NetParameters>>, ) -> StdResult<(), Bug>

Reconfigure all channels

pub(crate) fn expire_channels(&self) -> Duration

Expire any channels that have been unused longer than their maximum unused duration assigned during creation.

Return a duration from now until next channel expires.

If all channels are in use or there are no open channels, return 180 seconds which is the minimum value of max_unused_duration.