Struct libp2p_rendezvous::client::Behaviour

pub struct Behaviour { /* private fields */ }

Implementations

impl Behaviour

pub fn new(keypair: Keypair) -> Self

Create a new instance of the rendezvous NetworkBehaviour.

pub fn register( &mut self, namespace: Namespace, rendezvous_node: PeerId, ttl: Option<Ttl> )

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 NetworkBehaviourAction::ReportObservedAddr.

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, ns: 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 = SubstreamConnectionHandler<Void, Stream, OpenInfo>

Handler for all the protocols the network behaviour supports.

type OutEvent = Event

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

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

Callback that is invoked for every established inbound connection.

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_established_outbound_connection( &mut self, _: ConnectionId, _: PeerId, _: &Multiaddr, _: Endpoint ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: 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<'_>, _: &mut impl PollParameters ) -> Poll<NetworkBehaviourAction<Self::OutEvent, THandlerInEvent<Self>>>

Polls for things that swarm should do.

fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)

Informs the behaviour about an event from the Swarm.

fn new_handler(&mut self) -> Self::ConnectionHandler

👎Deprecated since 0.42.0: Use one or more of <code>NetworkBehaviour::{handle_pending_inbound_connection,handle_established_inbound_connection,handle_pending_outbound_connection,handle_established_outbound_connection}</code> instead.

Creates a new ConnectionHandler for a connection with a peer.

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.

fn addresses_of_peer(&mut self, _: &PeerId) -> Vec<Multiaddr, Global>

👎Deprecated: Use <code>NetworkBehaviour::handle_pending_outbound_connection</code> instead.

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.