Enum WebSocketRequest

pub enum WebSocketRequest {
    TrickleIce {
        candidate: Box<RtcIceCandidateInit>,
    },
    SdpOffer {
        offer: Box<RtcSessionDescription>,
    },
    ModelingCmdReq(ModelingCmdReq),
    ModelingCmdBatchReq(ModelingBatch),
    Ping {},
    MetricsResponse {
        metrics: Box<ClientMetrics>,
    },
    Debug {},
    Headers {
        headers: HashMap<String, String>,
    },
}

The websocket messages the server receives.

Variants

TrickleIce

The trickle ICE candidate request.

Fields

candidate: Box<RtcIceCandidateInit>

Information about the ICE candidate.

SdpOffer

The SDP offer request.

Fields

offer: Box<RtcSessionDescription>

The session description.

ModelingCmdReq(ModelingCmdReq)

The modeling command request.

ModelingCmdBatchReq(ModelingBatch)

A sequence of modeling requests. If any request fails, following requests will not be tried.

Ping

The client-to-server Ping to ensure the WebSocket stays alive.

MetricsResponse

The response to a metrics collection request from the server.

Fields

metrics: Box<ClientMetrics>

Collected metrics from the Client’s end of the engine connection.

Debug

Return information about the connected instance

Headers

Authentication header request.

Fields

headers: HashMap<String, String>

The authentication header.

Trait Implementations

impl Clone for WebSocketRequest

fn clone(&self) -> WebSocketRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebSocketRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WebSocketRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Serialize for WebSocketRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.