Struct libp2p_rendezvous::client::Behaviour

pub struct Behaviour { /* fields omitted */ }

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 ProtocolsHandler = SubstreamProtocolsHandler<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 new_handler(&mut self) -> Self::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

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

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

fn inject_event(
    &mut self,
    peer_id: PeerId,
    connection_id: ConnectionId,
    event: OutEvent<Void, OutEvent, Void, Error>
)

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

fn poll(
    &mut self,
    cx: &mut Context<'_>,
    poll_params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ProtocolsHandler>>

Polls for things that swarm should do.

fn inject_connected(&mut self, &PeerId)

Indicate to the behaviour that we connected to the node with the given peer id.

fn inject_disconnected(&mut self, &PeerId)

Indicates to the behaviour that we disconnected from the node with the given peer id.

fn inject_connection_established(
    &mut self,
    _peer_id: &PeerId,
    _connection_id: &ConnectionId,
    _endpoint: &ConnectedPoint,
    _failed_addresses: Option<&Vec<Multiaddr, Global>>
)

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed(
    &mut self,
    &PeerId,
    &ConnectionId,
    &ConnectedPoint,
    <Self::ProtocolsHandler as IntoProtocolsHandler>::Handler
)

Informs the behaviour about a closed connection to a peer.

fn inject_address_change(
    &mut self,
    &PeerId,
    &ConnectionId,
    _old: &ConnectedPoint,
    _new: &ConnectedPoint
)

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_dial_failure(
    &mut self,
    _peer_id: Option<PeerId>,
    _handler: Self::ProtocolsHandler,
    _error: &DialError
)

Indicates to the behaviour that the dial to a known or unknown node failed.

fn inject_listen_failure(
    &mut self,
    _local_addr: &Multiaddr,
    _send_back_addr: &Multiaddr,
    _handler: Self::ProtocolsHandler
)

Indicates to the behaviour that an error happened on an incoming connection during its initial handshake.

fn inject_new_listener(&mut self, _id: ListenerId)

Indicates to the behaviour that a new listener was created.

fn inject_new_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, _id: ListenerId, _addr: &Multiaddr)

Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_listener_error(
    &mut self,
    _id: ListenerId,
    _err: &(dyn Error + 'static)
)

A listener experienced an error.

fn inject_listener_closed(
    &mut self,
    _id: ListenerId,
    _reason: Result<(), &Error>
)

A listener closed.

fn inject_new_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn inject_expired_external_addr(&mut self, _addr: &Multiaddr)

Indicates to the behaviour that an external address was removed.