NatTraversalEvent

ant_quic::nat_traversal_api

Enum NatTraversalEvent

pub enum NatTraversalEvent {
    CandidateDiscovered {
        peer_id: PeerId,
        candidate: CandidateAddress,
    },
    CoordinationRequested {
        peer_id: PeerId,
        coordinator: SocketAddr,
    },
    CoordinationSynchronized {
        peer_id: PeerId,
        round_id: VarInt,
    },
    HolePunchingStarted {
        peer_id: PeerId,
        targets: Vec<SocketAddr>,
    },
    PathValidated {
        peer_id: PeerId,
        address: SocketAddr,
        rtt: Duration,
    },
    CandidateValidated {
        peer_id: PeerId,
        candidate_address: SocketAddr,
    },
    TraversalSucceeded {
        peer_id: PeerId,
        final_address: SocketAddr,
        total_time: Duration,
    },
    ConnectionEstablished {
        peer_id: PeerId,
        remote_address: SocketAddr,
    },
    TraversalFailed {
        peer_id: PeerId,
        error: NatTraversalError,
        fallback_available: bool,
    },
    ConnectionLost {
        peer_id: PeerId,
        reason: String,
    },
    PhaseTransition {
        peer_id: PeerId,
        from_phase: TraversalPhase,
        to_phase: TraversalPhase,
    },
    SessionStateChanged {
        peer_id: PeerId,
        new_state: ConnectionState,
    },
}

Expand description

Events generated during NAT traversal process

Variants§

CandidateDiscovered

New candidate address discovered

Fields

§peer_id: PeerId

The peer this event relates to

§candidate: CandidateAddress

The discovered candidate address

CoordinationRequested

Coordination request sent to bootstrap

Fields

§peer_id: PeerId

The peer this event relates to

§coordinator: SocketAddr

Coordinator address used for synchronization

CoordinationSynchronized

Peer coordination synchronized

Fields

§peer_id: PeerId

The peer this event relates to

§round_id: VarInt

The synchronized round identifier

HolePunchingStarted

Hole punching started

Fields

§peer_id: PeerId

The peer this event relates to

§targets: Vec<SocketAddr>

Target addresses to punch

PathValidated

Path validated successfully

Fields

§peer_id: PeerId

The peer this event relates to

§address: SocketAddr

Validated remote address

§rtt: Duration

Measured round-trip time

CandidateValidated

Candidate validated successfully

Fields

§peer_id: PeerId

The peer this event relates to

§candidate_address: SocketAddr

Validated candidate address

TraversalSucceeded

NAT traversal completed successfully

Fields

§peer_id: PeerId

The peer this event relates to

§final_address: SocketAddr

Final established address

§total_time: Duration

Total traversal time

ConnectionEstablished

Connection established after NAT traversal

Fields

§peer_id: PeerId

§remote_address: SocketAddr

The socket address where the connection was established

TraversalFailed

NAT traversal failed

Fields

§peer_id: PeerId

The peer ID that failed to connect

§error: NatTraversalError

The NAT traversal error that occurred

§fallback_available: bool

Whether fallback mechanisms are available

ConnectionLost

Connection lost

Fields

§peer_id: PeerId

The peer this event relates to

§reason: String

Reason for the connection loss

PhaseTransition

Phase transition in NAT traversal state machine

Fields

§peer_id: PeerId

The peer this event relates to

§from_phase: TraversalPhase

Old traversal phase

§to_phase: TraversalPhase

New traversal phase

SessionStateChanged

Session state changed

Fields

§peer_id: PeerId

The peer this event relates to

§new_state: ConnectionState

New connection state

Trait Implementations§

impl Clone for NatTraversalEvent

fn clone(&self) -> NatTraversalEvent

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

impl Debug for NatTraversalEvent

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for NatTraversalEvent

impl RefUnwindSafe for NatTraversalEvent

impl Send for NatTraversalEvent

impl Sync for NatTraversalEvent

impl Unpin for NatTraversalEvent

impl UnwindSafe for NatTraversalEvent

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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