Struct Behaviour

pub struct Behaviour { /* private fields */ }

Available on crate feature rendezvous only.

Implementations

impl Behaviour

pub fn new(keypair: Keypair) -> Behaviour

Create a new instance of the rendezvous NetworkBehaviour.

pub fn register( &mut self, namespace: Namespace, rendezvous_node: PeerId, ttl: Option<u64>, ) -> Result<(), RegisterError>

Register our external addresses in the given namespace with the given rendezvous peer.

External addresses are either manually added via libp2p_swarm::Swarm::add_external_address or reported by other NetworkBehaviours via ToSwarm::ExternalAddrConfirmed.

pub fn unregister(&mut self, namespace: Namespace, rendezvous_node: PeerId)

Unregister ourselves from the given namespace with the given rendezvous peer.

pub fn discover( &mut self, namespace: Option<Namespace>, cookie: Option<Cookie>, limit: Option<u64>, rendezvous_node: PeerId, )

Discover other peers at a given rendezvous peer.

If desired, the registrations can be filtered by a namespace. If no namespace is given, peers from all namespaces will be returned. A successfully discovery returns a cookie within Event::Discovered. Such a cookie can be used to only fetch the delta of registrations since the cookie was acquired.

Trait Implementations

impl NetworkBehaviour for Behaviour

type ConnectionHandler = <Behaviour<Codec> as NetworkBehaviour>::ConnectionHandler

Handler for all the protocols the network behaviour supports.

type ToSwarm = Event

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

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

Callback that is invoked for every established inbound connection.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, port_use: PortUse, ) -> Result<<Behaviour as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: 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 on_swarm_event(&mut self, event: FromSwarm<'_>)

Informs the behaviour about an event from the Swarm.

fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<<Behaviour as NetworkBehaviour>::ToSwarm, <<Behaviour as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>

Polls for things that swarm should do.

fn handle_pending_outbound_connection( &mut self, _connection_id: ConnectionId, maybe_peer: Option<PeerId>, _addresses: &[Multiaddr], _effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt.

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.