Struct Behaviour

pub struct Behaviour { /* private fields */ }

A NetworkBehaviour that enforces a set of ConnectionLimits.

For these limits to take effect, this needs to be composed into the behaviour tree of your application.

If a connection is denied due to a limit, either a SwarmEvent::IncomingConnectionError or SwarmEvent::OutgoingConnectionError will be emitted. The ListenError::Denied and respectively the DialError::Denied variant contain a ConnectionDenied type that can be downcast to Exceeded error if (and only if) this behaviour denied the connection.

If you employ multiple NetworkBehaviours that manage connections, it may also be a different error.

Example

#[derive(NetworkBehaviour)]
struct MyBehaviour {
  identify: identify::Behaviour,
  ping: ping::Behaviour,
  limits: connection_limits::Behaviour
}

Implementations

impl Behaviour

pub fn new(limits: ConnectionLimits) -> Behaviour

pub fn limits_mut(&mut self) -> &mut ConnectionLimits

Returns a mutable reference to ConnectionLimits.

Note: A new limit will not be enforced against existing connections.

Trait Implementations

impl NetworkBehaviour for Behaviour

type ConnectionHandler = ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = Void

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

fn handle_pending_inbound_connection( &mut self, connection_id: ConnectionId, _: &Multiaddr, _: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, _: &Multiaddr, _: &Multiaddr, ) -> Result<<Behaviour as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>

Callback that is invoked for every established inbound connection.

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

Callback that is invoked for every outbound connection attempt.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, _: &Multiaddr, _: Endpoint, _: PortUse, ) -> Result<<Behaviour as NetworkBehaviour>::ConnectionHandler, 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: <<Behaviour as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour, )

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, _: &mut Context<'_>, ) -> Poll<ToSwarm<<Behaviour as NetworkBehaviour>::ToSwarm, <<Behaviour as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>

Polls for things that swarm should do.