Struct sc_network::protocol_controller::ProtocolHandle

pub struct ProtocolHandle { /* private fields */ }

Shared handle to ProtocolController. Distributed around the code outside of the protocol implementation.

Implementations

impl ProtocolHandle

pub fn add_reserved_peer(&self, peer_id: PeerId)

Adds a new reserved peer. ProtocolController will make an effort to always remain connected to this peer.

Has no effect if the node was already a reserved peer.

Note: Keep in mind that the networking has to know an address for this node, otherwise it will not be able to connect to it.

pub fn remove_reserved_peer(&self, peer_id: PeerId)

Demotes reserved peer to non-reserved. Does not disconnect the peer.

Has no effect if the node was not a reserved peer.

pub fn set_reserved_peers(&self, peer_ids: HashSet<PeerId>)

Set reserved peers to the new set.

pub fn set_reserved_only(&self, reserved: bool)

Sets whether or not ProtocolController only has connections with nodes marked as reserved for the given set.

pub fn disconnect_peer(&self, peer_id: PeerId)

Disconnect peer. You should remove the PeerId from the PeerStore first to not connect to the peer again during the next slot allocation.

pub fn reserved_peers(&self, pending_response: Sender<Vec<PeerId>>)

Get the list of reserved peers.

pub fn incoming_connection( &self, peer_id: PeerId, incoming_index: IncomingIndex )

Notify about incoming connection. ProtocolController will either accept or reject it.

pub fn dropped(&self, peer_id: PeerId)

Notify that connection was dropped (either refused or disconnected).

Trait Implementations

impl Clone for ProtocolHandle

fn clone(&self) -> ProtocolHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProtocolHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.