Skip to main content

Output

antenna_protocol

Enum Output

pub enum Output<Msg: UserMsgPayload> {
Show 14 variants    Handshake {
        peer: PeerID,
        event: HandshakeOutput,
    },
    InitOpenOffer,
    OfferReady(SignalingPayload),
    AnswerReady(SignalingPayload),
    SendMessage {
        peer_to: PeerID,
        data: MsgPayload<Msg>,
    },
    ReceiveMessage {
        peer_from: PeerID,
        data: MsgPayload<Msg>,
    },
    PeerConnected {
        peer: PeerID,
    },
    PeerDisconnected {
        peer: PeerID,
    },
    PeerLost {
        peer: PeerID,
    },
    Connected,
    Available,
    Unavailable,
    Disconnecting,
    ScheduleTimer {
        kind: Scheduled,
        after_ms: u64,
    },
}

Expand description

Common event that client FSM sends

Variants§

Handshake

Handshake event for a known peer

Fields

§peer: PeerID

§event: HandshakeOutput

InitOpenOffer

Bootstrap host: create an open offer (joiner peer ID not yet known)

OfferReady(SignalingPayload)

Bootstrap host: open offer SDP is ready to be shared out-of-band with a joiner

AnswerReady(SignalingPayload)

Bootstrap joiner: SDP answer is ready to be shared out-of-band with the host

SendMessage

Send message to other peer in mesh

Fields

§peer_to: PeerID

§data: MsgPayload<Msg>

ReceiveMessage

Initiate receiving message from any outer sender

Fields

§peer_from: PeerID

§data: MsgPayload<Msg>

PeerConnected

Notify about new peer connected to mesh

Fields

§peer: PeerID

PeerDisconnected

Notify about peer that gracefully left the mesh

Fields

§peer: PeerID

PeerLost

Notify about peer lost due to connection failure (abrupt, candidate for reconnect)

Fields

§peer: PeerID

Connected

Node-level status: first peer reached Connected (FSMState: Init → Connected).

Available

Node-level status: all relay handshakes complete (FSMState: Connected → Available).

Unavailable

Node-level status: a relay handshake is in progress or no peers are connected (FSMState: Available → Connected, or any → Init).

Disconnecting

Local node sent disconnect notices to all peers; driver must close all connections (FSMState: anything → Left).

ScheduleTimer

Driver should schedule a timer

Fields

§kind: Scheduled

§after_ms: u64

Trait Implementations§

impl<Msg: Clone + UserMsgPayload> Clone for Output<Msg>

fn clone(&self) -> Output<Msg>

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<Msg: Debug + UserMsgPayload> Debug for Output<Msg>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<Msg> Freeze for Output<Msg>
where Msg: Freeze,

impl<Msg> RefUnwindSafe for Output<Msg>
where Msg: RefUnwindSafe,

impl<Msg> Send for Output<Msg>
where Msg: Send,

impl<Msg> Sync for Output<Msg>
where Msg: Sync,

impl<Msg> Unpin for Output<Msg>
where Msg: Unpin,

impl<Msg> UnsafeUnpin for Output<Msg>
where Msg: UnsafeUnpin,

impl<Msg> UnwindSafe for Output<Msg>
where Msg: UnwindSafe,

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, 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<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more

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

fn vzip(self) -> V