Struct Behaviour

pub struct Behaviour<S> { /* private fields */ }

A NetworkBehaviour that can act as an allow or block list.

Implementations

impl Behaviour<AllowedPeers>

pub fn allowed_peers(&self) -> &HashSet<PeerId>

Peers that are currently allowed.

pub fn allow_peer(&mut self, peer: PeerId) -> bool

Allow connections to the given peer.

Returns whether the peer was newly inserted. Does nothing if the peer was already present in the set.

pub fn disallow_peer(&mut self, peer: PeerId) -> bool

Disallow connections to the given peer.

All active connections to this peer will be closed immediately.

Returns whether the peer was present in the set. Does nothing if the peer was not present in the set.

impl Behaviour<BlockedPeers>

pub fn blocked_peers(&self) -> &HashSet<PeerId>

Peers that are currently blocked.

pub fn block_peer(&mut self, peer: PeerId) -> bool

Block connections to a given peer.

All active connections to this peer will be closed immediately.

Returns whether the peer was newly inserted. Does nothing if the peer was already present in the set.

pub fn unblock_peer(&mut self, peer: PeerId) -> bool

Unblock connections to a given peer.

Returns whether the peer was present in the set. Does nothing if the peer was not present in the set.

Trait Implementations

impl<S: Debug> Debug for Behaviour<S>

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

Formats the value using the given formatter.

impl<S: Default> Default for Behaviour<S>

fn default() -> Behaviour<S>

Returns the “default value” for a type.

impl<S> NetworkBehaviour for Behaviour<S>

where S: Enforce,

type ConnectionHandler = ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = Infallible

Event generated by the NetworkBehaviour and that the swarm will report back.

fn handle_established_inbound_connection( &mut self, _: ConnectionId, peer: PeerId, _: &Multiaddr, _: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

fn handle_pending_outbound_connection( &mut self, _: ConnectionId, peer: Option<PeerId>, _: &[Multiaddr], _: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

fn handle_established_outbound_connection( &mut self, _: ConnectionId, peer: PeerId, _: &Multiaddr, _: Endpoint, _: PortUse, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_swarm_event(&mut self, _event: FromSwarm<'_>)

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, _id: PeerId, _: ConnectionId, event: THandlerOutEvent<Self>, )

Informs the behaviour about an event generated by the ConnectionHandler dedicated to the peer identified by peer_id. for the behaviour.

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.

fn handle_pending_inbound_connection( &mut self, _connection_id: ConnectionId, _local_addr: &Multiaddr, _remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.