Enum RelayToClientMsg 

pub enum RelayToClientMsg {
    Datagrams {
        remote_endpoint_id: EndpointId,
        datagrams: Datagrams,
    },
    EndpointGone(EndpointId),
    Health {
        problem: String,
    },
    Restarting {
        reconnect_in: Duration,
        try_for: Duration,
    },
    Ping([u8; 8]),
    Pong([u8; 8]),
}

The messages that a relay sends to clients or the clients receive from the relay.

Variants

Datagrams

Represents datagrams sent from relays (originally sent to them by another client).

Fields

remote_endpoint_id: EndpointId

The EndpointId of the original sender.

datagrams: Datagrams

The datagrams and related metadata.

EndpointGone(EndpointId)

Indicates that the client identified by the underlying public key had previously sent you a packet but has now disconnected from the relay.

Health

A one-way message from relay to client, declaring the connection health state.

Fields

problem: String

If set, is a description of why the connection is unhealthy.

If None means the connection is healthy again.

The default condition is healthy, so the relay doesn’t broadcast a RelayToClientMsg::Health until a problem exists.

Restarting

A one-way message from relay to client, advertising that the relay is restarting.

Fields

reconnect_in: Duration

An advisory duration that the client should wait before attempting to reconnect. It might be zero. It exists for the relay to smear out the reconnects.

try_for: Duration

An advisory duration for how long the client should attempt to reconnect before giving up and proceeding with its normal connection failure logic. The interval between retries is undefined for now. A relay should not send a try_for duration more than a few seconds.

Ping([u8; 8])

Request from the relay to reply to the other side with a ClientToRelayMsg::Pong with the given payload.

Pong([u8; 8])

Reply to a ClientToRelayMsg::Ping from a client with the payload sent previously in the ping.

Implementations

impl RelayToClientMsg

pub fn typ(&self) -> FrameType

Returns this frame’s corresponding frame type.

Trait Implementations

impl Clone for RelayToClientMsg

fn clone(&self) -> RelayToClientMsg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelayToClientMsg

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

Formats the value using the given formatter.

impl PartialEq for RelayToClientMsg

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for RelayToClientMsg

impl StructuralPartialEq for RelayToClientMsg