Struct Behaviour

pub struct Behaviour { /* private fields */ }

Available on crate feature memory-connection-limits only.

A NetworkBehaviour that enforces a set of memory usage based limits.

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 MemoryUsageLimitExceeded 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.

Behaviour::with_max_bytes and Behaviour::with_max_percentage are mutually exclusive. If you need to employ both of them, compose two instances of Behaviour into your custom behaviour.

Example

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

Implementations

impl Behaviour

pub fn with_max_bytes(max_allowed_bytes: usize) -> Behaviour

Sets the process memory usage threshold in absolute bytes.

New inbound and outbound connections will be denied when the threshold is reached.

pub fn with_max_percentage(percentage: f64) -> Behaviour

Sets the process memory usage threshold in the percentage of the total physical memory.

New inbound and outbound connections will be denied when the threshold is reached.

pub fn max_allowed_bytes(&self) -> usize

Gets the process memory usage threshold in bytes.

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, _: ConnectionId, _: &Multiaddr, _: &Multiaddr, ) -> Result<(), ConnectionDenied>

Callback that is invoked for every new inbound connection.

fn handle_established_inbound_connection( &mut self, _: ConnectionId, _: 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, _: 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, _: ConnectionId, _: 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, _: 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.