Struct MgrState

pub(crate) struct MgrState<C: AbstractChannelFactory> {
    inner: Mutex<Inner<C>>,
}

All mutable state held by an AbstractChannelMgr.

One reason that this is an isolated type is that we want to to limit the amount of code that can see and lock the Mutex here. (We’re using a blocking mutex close to async code, so we need to be careful.)

Fields

inner: Mutex<Inner<C>>

The data, within a lock

(Danger: this uses a blocking mutex close to async code. This mutex must never be held while an await is happening.)

Implementations

impl<C: AbstractChannelFactory> MgrState<C>

pub(crate) fn new( builder: C, config: ChannelConfig, dormancy: Dormancy, netparams: &NetParameters, ) -> Self

Create a new empty MgrState.

pub(crate) fn builder(&self) -> C

where C: Clone,

Return a copy of the builder stored in this state.

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

where F: FnOnce(&mut C),

Run a function to modify the builder stored in this state.

Deadlock

Calling a method on MgrState from within func may cause a deadlock.

pub(crate) fn request_channel( &self, target: &C::BuildSpec, add_new_entry_if_not_found: bool, ) -> Result<Option<ChannelForTarget<C>>>

Request an open or pending channel to target. If add_new_entry_if_not_found is true and an open or pending channel isn’t found, a new pending entry will be added and ChannelForTarget::NewEntry will be returned. This is all done as part of the same method so that all operations are performed under the same lock acquisition.

pub(crate) fn remove_pending_channel( &self, handle: PendingChannelHandle, ) -> Result<()>

Remove the pending channel identified by its handle.

pub(crate) fn upgrade_pending_channel_to_open( &self, handle: PendingChannelHandle, channel: Arc<C::Channel>, ) -> Result<()>

Upgrade the pending channel identified by its handle by replacing it with a new open channel.

pub(super) fn reconfigure_general( &self, new_config: Option<&ChannelConfig>, new_dormancy: Option<Dormancy>, netparams: Arc<dyn AsRef<NetParameters>>, ) -> StdResult<(), Bug>

Reconfigure all channels as necessary

(By reparameterizing channels as needed) This function will handle

• netdir update
• a reconfiguration
• dormancy

For new_config and new_dormancy, None means “no change to previous info”.

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

Expire all channels that have been unused for too long.

Return a Duration until the next time at which a channel could expire.