Struct libp2p_relay::v2::relay::Relay

pub struct Relay { /* private fields */ }

Relay is a NetworkBehaviour that implements the relay server functionality of the circuit relay v2 protocol.

Implementations

impl Relay

pub fn new(local_peer_id: PeerId, config: Config) -> Self

Trait Implementations

impl NetworkBehaviour for Relay

type ProtocolsHandler = Prototype

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 inject_connection_closed(
    &mut self,
    peer: &PeerId,
    connection: &ConnectionId,
    _: &ConnectedPoint,
    _handler: Either<Handler, DummyProtocolsHandler>
)

Informs the behaviour about a closed connection to a peer.

fn inject_event(
    &mut self,
    event_source: PeerId,
    connection: ConnectionId,
    event: Either<Event, Void>
)

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_parameters: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ProtocolsHandler>>

Polls for things that swarm should do.

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

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

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