Enum Command 

pub enum Command {
    SendWebSocket {
        frame: String,
    },
    ApplyNegotiation {
        request_id: RequestId,
        kind: NegotiationKind,
        sdp: String,
        upload_slots: Vec<NegotiationUploadSlot>,
    },
    ClosePeerConnection,
    CloseWebSocket {
        code: u16,
    },
    EmitStateChange {
        state: ConnectionState,
        cause: Option<String>,
    },
    SetAvailableFeatures {
        features: AvailableFeatures,
    },
    SetRecordingState {
        state: RecordingState,
    },
    EmitEvent {
        event: ProtocolEvent,
    },
    BeginPendingRequest {
        request: PendingRequest,
    },
    CompletePendingRequest {
        request_id: RequestId,
        timeout_timer_id: u32,
        ok: bool,
    },
    ScheduleTimer {
        id: u32,
        ms: u32,
    },
    CancelTimer {
        id: u32,
    },
    Connect {
        url: String,
    },
}

One ordered side effect for the host that drives ProtocolCore.

The host must execute each returned vector before reporting follow-up events.

Variants

SendWebSocket

Serialize and send a JSON frame over the WebSocket.

Fields

frame: String

ApplyNegotiation

Apply a remote SDP offer to the local RTCPeerConnection.

Fields

request_id: RequestId

kind: NegotiationKind

sdp: String

upload_slots: Vec<NegotiationUploadSlot>

ClosePeerConnection

CloseWebSocket

Fields

code: u16

EmitStateChange

Notify listeners of a connection-state transition, with an optional human-readable cause (e.g. "kicked", "full").

Fields

state: ConnectionState

cause: Option<String>

SetAvailableFeatures

Fields

features: AvailableFeatures

SetRecordingState

Fields

state: RecordingState

EmitEvent

Emit a protocol-domain event for the host projection layer.

Fields

event: ProtocolEvent

BeginPendingRequest

Fields

request: PendingRequest

CompletePendingRequest

Cancel timeout_timer_id before resolving request_id.

Fields

request_id: RequestId

timeout_timer_id: u32

ok: bool

ScheduleTimer

Start a one-shot timer; the host must call ProtocolCore::on_timer when it fires.

Fields

id: u32

ms: u32

CancelTimer

Fields

id: u32

Connect

Open a new WebSocket to the given URL.

Fields

url: String

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl PartialEq for Command

fn eq(&self, other: &Command) -> 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 Serialize for Command

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Command

impl StructuralPartialEq for Command