Struct phron_finality::network::session::manager::Manager

pub struct Manager<NI: NetworkIdentity, D: Data, VCU: ValidatorAddressCacheUpdater> {
    network_identity: NI,
    connections: Connections<NI::PeerId>,
    sessions: HashMap<SessionId, Session<D, NI::AddressingInformation>>,
    validator_address_cache_updater: VCU,
    discovery_cooldown: Duration,
}

The connection manager. It handles the abstraction over the network we build to support separate sessions. This includes:

1. Starting and ending specific sessions on user demand.
2. Forwarding in-session user messages to the network using session handlers for address translation.
3. Handling network messages:
   1. In-session messages are forwarded to the user.
   2. Authentication messages forwarded to session handlers.
4. Running periodic maintenance, mostly related to node discovery.

Fields

network_identity: NI

connections: Connections<NI::PeerId>

sessions: HashMap<SessionId, Session<D, NI::AddressingInformation>>

validator_address_cache_updater: VCU

discovery_cooldown: Duration

Implementations

impl<NI: NetworkIdentity, D: Data, VCU: ValidatorAddressCacheUpdater> Manager<NI, D, VCU>

pub fn new( network_identity: NI, validator_address_cache_updater: VCU, discovery_cooldown: Duration ) -> Self

Create a new connection manager.

fn delete_reserved( to_remove: HashSet<NI::PeerId> ) -> Option<ConnectionCommand<NI::AddressingInformation>>

pub fn finish_session( &mut self, session_id: SessionId ) -> ManagerActions<NI::AddressingInformation>

Ends a session.

fn discover_authorities( &mut self, session_id: &SessionId ) -> Option<Authentication<NI::AddressingInformation>>

pub fn discovery(&mut self) -> Vec<Authentication<NI::AddressingInformation>>

Returns all the network messages that should be sent as part of discovery at this moment.

fn start_validator_session( &mut self, pre_session: PreValidatorSession, address: NI::AddressingInformation ) -> (Option<Authentication<NI::AddressingInformation>>, UnboundedReceiver<D>)

pub fn update_validator_session( &mut self, pre_session: PreValidatorSession ) -> Result<(ManagerActions<NI::AddressingInformation>, UnboundedReceiver<D>), SessionHandlerError>

Starts or updates a validator session.

fn start_nonvalidator_session( &mut self, pre_session: PreNonvalidatorSession, address: NI::AddressingInformation )

pub fn update_nonvalidator_session( &mut self, pre_session: PreNonvalidatorSession ) -> Result<ManagerActions<NI::AddressingInformation>, SessionHandlerError>

Starts or updates a nonvalidator session.

pub fn on_user_message( &self, data: D, session_id: SessionId, recipient: Recipient ) -> Vec<(DataInSession<D>, NI::PeerId)>

Handle a user request for sending data. Returns a list of data to be sent over the network.

pub fn on_discovery_message( &mut self, message: Authentication<NI::AddressingInformation> ) -> ManagerActions<NI::AddressingInformation>

Handle a discovery message. Returns actions the manager wants to take.

pub fn send_session_data( &self, session_id: &SessionId, data: D ) -> Result<(), SendError>

Sends the data to the identified session.

pub fn status_report(&self)