NodeEvent

Enum NodeEvent 

Source
pub enum NodeEvent {
    PeerConnected {
        peer_id: PeerId,
        addr: SocketAddr,
        direct: bool,
    },
    PeerDisconnected {
        peer_id: PeerId,
        reason: DisconnectReason,
    },
    ConnectionFailed {
        addr: SocketAddr,
        error: String,
    },
    ExternalAddressDiscovered {
        addr: SocketAddr,
    },
    NatTypeDetected {
        nat_type: NatType,
    },
    NatTraversalComplete {
        peer_id: PeerId,
        success: bool,
        method: TraversalMethod,
    },
    RelaySessionStarted {
        peer_id: PeerId,
    },
    RelaySessionEnded {
        peer_id: PeerId,
        bytes_forwarded: u64,
    },
    CoordinationStarted {
        peer_a: PeerId,
        peer_b: PeerId,
    },
    CoordinationComplete {
        peer_a: PeerId,
        peer_b: PeerId,
        success: bool,
    },
    DataReceived {
        peer_id: PeerId,
        stream_id: u64,
        bytes: usize,
    },
    DataSent {
        peer_id: PeerId,
        stream_id: u64,
        bytes: usize,
    },
}
Expand description

Unified event type for all node activities

Subscribe to these events via node.subscribe() to monitor all significant node activities in real-time.

Variants§

§

PeerConnected

A peer connected successfully

Fields

§peer_id: PeerId

The connected peer’s ID

§addr: SocketAddr

The peer’s address

§direct: bool

Whether this is a direct connection (vs relayed)

§

PeerDisconnected

A peer disconnected

Fields

§peer_id: PeerId

The disconnected peer’s ID

§reason: DisconnectReason

Reason for disconnection

§

ConnectionFailed

Connection attempt failed

Fields

§addr: SocketAddr

Target address that failed

§error: String

Error message

§

ExternalAddressDiscovered

External address discovered

This is the address as seen by other peers.

Fields

§addr: SocketAddr

The discovered external address

§

NatTypeDetected

NAT type detected

Fields

§nat_type: NatType

The detected NAT type

§

NatTraversalComplete

NAT traversal completed

Fields

§peer_id: PeerId

The peer we traversed to

§success: bool

Whether traversal was successful

§method: TraversalMethod

Connection method used

§

RelaySessionStarted

Started relaying for a peer

Fields

§peer_id: PeerId

The peer we’re relaying for

§

RelaySessionEnded

Stopped relaying for a peer

Fields

§peer_id: PeerId

The peer we were relaying for

§bytes_forwarded: u64

Total bytes forwarded during session

§

CoordinationStarted

Started coordinating NAT traversal for peers

Fields

§peer_a: PeerId

Peer A in the coordination

§peer_b: PeerId

Peer B in the coordination

§

CoordinationComplete

NAT traversal coordination completed

Fields

§peer_a: PeerId

Peer A in the coordination

§peer_b: PeerId

Peer B in the coordination

§success: bool

Whether coordination was successful

§

DataReceived

Data received from a peer

Fields

§peer_id: PeerId

The peer that sent data

§stream_id: u64

Stream ID (for multiplexed connections)

§bytes: usize

Number of bytes received

§

DataSent

Data sent to a peer

Fields

§peer_id: PeerId

The peer we sent data to

§stream_id: u64

Stream ID

§bytes: usize

Number of bytes sent

Implementations§

Source§

impl NodeEvent

Source

pub fn is_connection_event(&self) -> bool

Check if this is a connection event

Source

pub fn is_nat_event(&self) -> bool

Check if this is a NAT-related event

Source

pub fn is_relay_event(&self) -> bool

Check if this is a relay event

Source

pub fn is_coordination_event(&self) -> bool

Check if this is a coordination event

Source

pub fn is_data_event(&self) -> bool

Check if this is a data event

Source

pub fn peer_id(&self) -> Option<&PeerId>

Get the peer ID associated with this event (if any)

Trait Implementations§

Source§

impl Clone for NodeEvent

Source§

fn clone(&self) -> NodeEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for NodeEvent

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

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 for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more