iroh_net::relay

Enum ReceivedMessage

Source
pub enum ReceivedMessage {
    ReceivedPacket {
        source: PublicKey,
        data: Bytes,
    },
    PeerGone(PublicKey),
    Ping([u8; 8]),
    Pong([u8; 8]),
    KeepAlive,
    Health {
        problem: Option<String>,
    },
    ServerRestarting {
        reconnect_in: Duration,
        try_for: Duration,
    },
}
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate
Expand description

The type of message received by the Conn from a relay server.

Variants§

§

ReceivedPacket

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Represents an incoming packet.

Fields

§source: PublicKey
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

The PublicKey of the packet sender.

§data: Bytes
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

The received packet bytes.

§

PeerGone(PublicKey)

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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

§

Ping([u8; 8])

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Request from a client or server to reply to the other side with a ReceivedMessage::Pong with the given payload.

§

Pong([u8; 8])

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

Reply to a ReceivedMessage::Ping from a client or server with the payload sent previously in the ping.

§

KeepAlive

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

A one-way empty message from server to client, just to keep the connection alive. It’s like a ReceivedMessage::Ping, but doesn’t solicit a reply from the client.

§

Health

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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

Fields

§problem: Option<String>
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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 server doesn’t broadcast a ReceivedMessage::Health until a problem exists.

§

ServerRestarting

👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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

Fields

§reconnect_in: Duration
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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

§try_for: Duration
👎Deprecated: This crate has been renamed from ‘iroh-net’ to ‘iroh’, please use the new crate

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 server should not send a TryFor duration more than a few seconds.

Trait Implementations§

Source§

impl Clone for ReceivedMessage

Source§

fn clone(&self) -> ReceivedMessage

Returns a copy 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 ReceivedMessage

Source§

fn fmt(&self, __derive_more_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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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, dst: *mut u8)

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

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T