Enum TunnelEventKind 

pub enum TunnelEventKind {
    RelayReady {
        latency_ms: u64,
    },
    RelayFailed {
        failure: RecoveryFailure,
        retry_in_ms: u64,
    },
    NetworkChanged,
    DirectEstablished {
        setup_ms: u64,
    },
    DirectFallback {
        stage: DirectStage,
    },
    Stopped,
    PhaseChanged {
        phase: RecoveryPhase,
    },
    DirectStageChanged {
        stage: DirectStage,
    },
    DirectAbandoned {
        stage: DirectStage,
    },
    SessionOpened {
        path: SessionPath,
    },
    SessionClosed {
        path: SessionPath,
    },
    PortMappingChanged {
        mapping: Box<PortMappingStatus>,
    },
}

What happened, in a TunnelEvent.

The first six are outcomes, kept in TunnelDiagnostics::events as well as delivered to TunnelEvents. The rest are steps along the way, delivered live only: kept, they would crowd the outcomes out of a history of 16.

Variants

RelayReady

The relay answered for the first time, or again after failures.

Fields

latency_ms: u64

RelayFailed

A relay attempt failed; the next one is retry_in_ms away (zero when the worker retries at once or the failure is final).

Fields

failure: RecoveryFailure

retry_in_ms: u64

NetworkChanged

The local network changed; recovery restarts at once.

DirectEstablished

A session took the direct path.

Fields

setup_ms: u64

DirectFallback

A session gave up on direct at stage and used the relay.

Fields

stage: DirectStage

Stopped

The tunnel stopped, and whatever it was cleaning up has reported. The last event of every stream.

PhaseChanged

A relay attempt entered phase. Once the tunnel is ready, its routine re-checks are not announced: the next change is backoff, when one fails.

Fields

phase: RecoveryPhase

DirectStageChanged

A direct attempt entered stage.

Fields

stage: DirectStage

DirectAbandoned

A direct attempt ended at stage with neither a direct session nor a fallback: its setup was cancelled, or it failed after committing, when the relay can no longer take its place.

Fields

stage: DirectStage

SessionOpened

A session opened on path.

Fields

path: SessionPath

SessionClosed

A session on path closed.

Fields

path: SessionPath

PortMappingChanged

The gateway mapping of the tunnel’s direct endpoint changed.

Fields

mapping: Box<PortMappingStatus>

Trait Implementations

impl Clone for TunnelEventKind

fn clone(&self) -> TunnelEventKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TunnelEventKind

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

Formats the value using the given formatter.

impl Eq for TunnelEventKind

impl PartialEq for TunnelEventKind

fn eq(&self, other: &TunnelEventKind) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for TunnelEventKind

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TunnelEventKind