Struct RouteWebsocket 

pub struct RouteWebsocket {
    pub origins: Vec<String>,
    pub max_frames_per_sec: Option<u64>,
    pub idle_timeout_s: Option<u64>,
    pub max_frame_size_bytes: Option<u64>,
}

Route-scoped WebSocket policy (DW-039, routes[].websocket).

Both knobs are opt-in and independent: an origins list gates the upgrade handshake (403 before any upstream contact), and max_frames_per_sec polices the ESTABLISHED tunnel (a client sending data frames faster than the allowance is closed with a 1008 policy-violation close frame and disconnected). The policing works on the client-to-upstream direction only — the gateway protects upstreams from abusive clients, not the reverse (an abusive upstream is the operator’s backend problem).

Fields

origins: Vec<String>

Allowed Origin header values for the upgrade handshake (case-sensitive exact match, e.g. https://app.example.com). Empty or absent: every origin is allowed (the transparent default). Non-empty: ONLY listed origins upgrade — a missing Origin header is DENIED (browsers always send one on WebSocket handshakes; a request without one is not a browser and must be named explicitly or fail closed). The literal string null matches the sandboxed-document origin by exact match.

max_frames_per_sec: Option<u64>

Post-upgrade policing: the sustained allowance of DATA frames (text, binary, continuation — control frames are free) the CLIENT may send per second, with a one-second burst of the same size. A client past its allowance is closed with close code 1008 (policy violation) and disconnected. Absent: no policing (unlimited, the transparent default). Validation enforces 1..=limits::MAX_WEBSOCKET_FRAMES_PER_SEC.

idle_timeout_s: Option<u64>

Post-upgrade idle timeout in seconds (DP-05, #253). If no data flows in either direction for this duration, the tunnel is closed. Absent: no idle timeout (the tunnel stays open until one side closes, the prior default). Validation enforces 1..=86400 (1 second to 24 hours).

max_frame_size_bytes: Option<u64>

Maximum payload size of a single WebSocket DATA frame in bytes (DP-05, #253). A frame exceeding this limit causes the connection to be closed with close code 1009 (message too big). Absent: no frame size limit (the prior default). Validation enforces 1..=16777216 (1 byte to 16 MiB).

Trait Implementations

impl Clone for RouteWebsocket

fn clone(&self) -> RouteWebsocket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RouteWebsocket

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RouteWebsocket

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for RouteWebsocket

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

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 inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for RouteWebsocket

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RouteWebsocket