Enum libp2p_core::network::NetworkEvent

source · [−]

pub enum NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler> where
    TTrans: Transport,
    THandler: IntoConnectionHandler,  {
    ListenerClosed {
        listener_id: ListenerId,
        addresses: Vec<Multiaddr>,
        reason: Result<(), TTrans::Error>,
    },
    ListenerError {
        listener_id: ListenerId,
        error: TTrans::Error,
    },
    NewListenerAddress {
        listener_id: ListenerId,
        listen_addr: Multiaddr,
    },
    ExpiredListenerAddress {
        listener_id: ListenerId,
        listen_addr: Multiaddr,
    },
    IncomingConnection {
        listener_id: ListenerId,
        connection: IncomingConnection<TTrans::ListenerUpgrade>,
    },
    IncomingConnectionError {
        local_addr: Multiaddr,
        send_back_addr: Multiaddr,
        error: PendingConnectionError<TTrans::Error>,
    },
    ConnectionEstablished {
        connection: EstablishedConnection<'a, TInEvent>,
        num_established: NonZeroU32,
    },
    ConnectionClosed {
        id: ConnectionId,
        connected: Connected,
        error: Option<ConnectionError<<THandler::Handler as ConnectionHandler>::Error>>,
        num_established: u32,
    },
    DialError {
        attempts_remaining: u32,
        peer_id: PeerId,
        multiaddr: Multiaddr,
        error: PendingConnectionError<TTrans::Error>,
    },
    UnknownPeerDialError {
        multiaddr: Multiaddr,
        error: PendingConnectionError<TTrans::Error>,
    },
    ConnectionEvent {
        connection: EstablishedConnection<'a, TInEvent>,
        event: TOutEvent,
    },
    AddressChange {
        connection: EstablishedConnection<'a, TInEvent>,
        new_endpoint: ConnectedPoint,
        old_endpoint: ConnectedPoint,
    },
}

Expand description

Event that can happen on the Network.

Variants

`ListenerClosed`

Fields

listener_id: ListenerId

The listener ID that closed.

addresses: Vec<Multiaddr>

The addresses that the listener was listening on.

reason: Result<(), TTrans::Error>

Reason for the closure. Contains Ok(()) if the stream produced None, or Err if the stream produced an error.

One of the listeners gracefully closed.

`ListenerError`

Fields

listener_id: ListenerId

The listener that errored.

error: TTrans::Error

The listener error.

One of the listeners reported a non-fatal error.

`NewListenerAddress`

Fields

listener_id: ListenerId

The listener that is listening on the new address.

listen_addr: Multiaddr

The new address the listener is now also listening on.

One of the listeners is now listening on an additional address.

`ExpiredListenerAddress`

Fields

listener_id: ListenerId

The listener that is no longer listening on some address.

listen_addr: Multiaddr

The expired address.

One of the listeners is no longer listening on some address.

`IncomingConnection`

Fields

listener_id: ListenerId

The listener who received the connection.

connection: IncomingConnection<TTrans::ListenerUpgrade>

The pending incoming connection.

A new connection arrived on a listener.

To accept the connection, see Network::accept.

`IncomingConnectionError`

Fields

local_addr: Multiaddr

Local connection address.

send_back_addr: Multiaddr

Address used to send back data to the remote.

error: PendingConnectionError<TTrans::Error>

The error that happened.

An error happened on a connection during its initial handshake.

This can include, for example, an error during the handshake of the encryption layer, or the connection unexpectedly closed.

`ConnectionEstablished`

Fields

connection: EstablishedConnection<'a, TInEvent>

The newly established connection.

num_established: NonZeroU32

The total number of established connections to the same peer, including the one that has just been opened.

A new connection to a peer has been established.

`ConnectionClosed`

Fields

id: ConnectionId

The ID of the connection that encountered an error.

connected: Connected

Information about the connection that encountered the error.

error: Option<ConnectionError<<THandler::Handler as ConnectionHandler>::Error>>

The error that occurred.

num_established: u32

The remaining number of established connections to the same peer.

An established connection to a peer has been closed.

A connection may close if

it encounters an error, which includes the connection being closed by the remote. In this case error is Some.
it was actively closed by EstablishedConnection::start_close, i.e. a successful, orderly close. In this case error is None.
it was actively closed by super::peer::ConnectedPeer::disconnect or super::peer::DialingPeer::disconnect, i.e. dropped without an orderly close. In this case error is None.

`DialError`

Fields

attempts_remaining: u32

The number of remaining dialing attempts.

peer_id: PeerId

Id of the peer we were trying to dial.

multiaddr: Multiaddr

The multiaddr we failed to reach.

error: PendingConnectionError<TTrans::Error>

The error that happened.

A dialing attempt to an address of a peer failed.

`UnknownPeerDialError`

Fields

multiaddr: Multiaddr

The multiaddr we failed to reach.

error: PendingConnectionError<TTrans::Error>

The error that happened.

Failed to reach a peer that we were trying to dial.

`ConnectionEvent`

Fields

connection: EstablishedConnection<'a, TInEvent>

The connection on which the event occurred.

event: TOutEvent

Event that was produced by the node.

An established connection produced an event.

`AddressChange`

Fields

connection: EstablishedConnection<'a, TInEvent>

The connection whose address has changed.

new_endpoint: ConnectedPoint

New endpoint of this connection.

old_endpoint: ConnectedPoint

Old endpoint of this connection.

An established connection has changed its address.

Trait Implementations

source

impl<TTrans, TInEvent, TOutEvent, THandler> Debug for NetworkEvent<'_, TTrans, TInEvent, TOutEvent, THandler> where
 TInEvent: Debug,
 TOutEvent: Debug,
 TTrans: Transport,
 TTrans::Error: Debug,
 THandler: IntoConnectionHandler,
 <THandler::Handler as ConnectionHandler>::Error: Debug,

source

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<'a, TTrans, TInEvent, TOutEvent, THandler> !RefUnwindSafe for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler>

impl<'a, TTrans, TInEvent, TOutEvent, THandler> Send for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler> where
 TInEvent: Send,
 TOutEvent: Send,
 <TTrans as Transport>::Error: Send,
 <<THandler as IntoConnectionHandler>::Handler as ConnectionHandler>::Error: Send,
 <TTrans as Transport>::ListenerUpgrade: Send,

impl<'a, TTrans, TInEvent, TOutEvent, THandler> Sync for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler> where
 TInEvent: Send,
 TOutEvent: Sync,
 <TTrans as Transport>::Error: Sync,
 <<THandler as IntoConnectionHandler>::Handler as ConnectionHandler>::Error: Sync,
 <TTrans as Transport>::ListenerUpgrade: Sync,

impl<'a, TTrans, TInEvent, TOutEvent, THandler> Unpin for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler> where
 TOutEvent: Unpin,
 <TTrans as Transport>::Error: Unpin,
 <<THandler as IntoConnectionHandler>::Handler as ConnectionHandler>::Error: Unpin,
 <TTrans as Transport>::ListenerUpgrade: Unpin,

impl<'a, TTrans, TInEvent, TOutEvent, THandler> !UnwindSafe for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler>

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Enum libp2p_core::network::NetworkEvent

Variants

ListenerClosed

Fields

ListenerError

Fields

NewListenerAddress

Fields

ExpiredListenerAddress

Fields

IncomingConnection

Fields

IncomingConnectionError

Fields

ConnectionEstablished

Fields

ConnectionClosed

Fields

DialError

Fields

UnknownPeerDialError

Fields

ConnectionEvent

Fields

AddressChange

Fields

Trait Implementations

impl<TTrans, TInEvent, TOutEvent, THandler> Debug for NetworkEvent<'_, TTrans, TInEvent, TOutEvent, THandler> where TInEvent: Debug, TOutEvent: Debug, TTrans: Transport, TTrans::Error: Debug, THandler: IntoConnectionHandler, <THandler::Handler as ConnectionHandler>::Error: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Auto Trait Implementations

impl<'a, TTrans, TInEvent, TOutEvent, THandler> !RefUnwindSafe for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler>

impl<'a, TTrans, TInEvent, TOutEvent, THandler> !UnwindSafe for NetworkEvent<'a, TTrans, TInEvent, TOutEvent, THandler>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

`ListenerClosed`

`ListenerError`

`NewListenerAddress`

`ExpiredListenerAddress`

`IncomingConnection`

`IncomingConnectionError`

`ConnectionEstablished`

`ConnectionClosed`

`DialError`

`UnknownPeerDialError`

`ConnectionEvent`

`AddressChange`

impl<TTrans, TInEvent, TOutEvent, THandler> Debug for NetworkEvent<'_, TTrans, TInEvent, TOutEvent, THandler> where
TInEvent: Debug,
TOutEvent: Debug,
TTrans: Transport,
TTrans::Error: Debug,
THandler: IntoConnectionHandler,
<THandler::Handler as ConnectionHandler>::Error: Debug,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,