Struct phron_finality::network::session::handler::Handler

pub struct Handler<A: AddressingInformation> {
    peers_by_node: HashMap<NodeIndex, A::PeerId>,
    authentications: HashMap<A::PeerId, Authentication<A>>,
    session_info: SessionInfo<A>,
    own_peer_id: A::PeerId,
    authority_index_and_pen: Option<(NodeIndex, AuthorityPen)>,
    authority_verifier: AuthorityVerifier,
}

A struct for handling authentications for a given session and maintaining mappings between PeerIds and NodeIndexes within that session.

Fields

peers_by_node: HashMap<NodeIndex, A::PeerId>

authentications: HashMap<A::PeerId, Authentication<A>>

session_info: SessionInfo<A>

own_peer_id: A::PeerId

authority_index_and_pen: Option<(NodeIndex, AuthorityPen)>

authority_verifier: AuthorityVerifier

Implementations

impl<A: AddressingInformation> Handler<A>

pub fn new( authority_index_and_pen: Option<(NodeIndex, AuthorityPen)>, authority_verifier: AuthorityVerifier, session_id: SessionId, address: A ) -> Handler<A>

Creates a new session handler. It will be a validator session handler if the authority index and pen are provided.

fn index(&self) -> Option<NodeIndex>

pub fn is_validator(&self) -> bool

pub fn node_count(&self) -> NodeCount

pub fn session_id(&self) -> SessionId

pub fn authentication(&self) -> Option<Authentication<A>>

Returns the authentication for the node and session this handler is responsible for.

pub fn missing_nodes(&self) -> Vec<NodeIndex>

Returns a vector of indices of nodes for which the handler has no authentication.

pub fn handle_authentication( &mut self, authentication: Authentication<A> ) -> Option<A>

Verifies the authentication, uses it to update mappings, and returns the address we should stay connected to if any.

pub fn peer_id(&self, node_id: &NodeIndex) -> Option<A::PeerId>

Returns the PeerId of the node with the given NodeIndex, if known.

pub fn peers(&self) -> HashMap<NodeIndex, A::PeerId>

Returns maping from NodeIndex to PeerId

pub fn update( &mut self, authority_index_and_pen: Option<(NodeIndex, AuthorityPen)>, authority_verifier: AuthorityVerifier, address: A ) -> Result<Vec<A>, HandlerError>

Updates the handler with the given keychain and set of own addresses. Returns an error if the set of addresses is not valid. All authentications will be rechecked, invalid ones purged. Own authentication will be regenerated. If successful returns a set of addresses that we should be connected to.