Struct WebsocketSourceConfig 

pub struct WebsocketSourceConfig {

    pub url: String,
    pub auth: AuthSpec<WebsocketAuth>,
    pub subscribe_messages: Vec<String>,
    pub message_format: WsMessageFormat,
    pub on_parse_error: OnParseError,
    pub envelope: bool,
    pub ping_interval: Option<Duration>,
    pub max_messages: Option<usize>,
    pub idle_timeout: Option<Duration>,
    pub reconnect: bool,
    pub reconnect_backoff: Duration,
    pub max_reconnect_attempts: Option<usize>,
    pub max_message_bytes: Option<usize>,
    pub batch_size: usize,
}

Available on crate features source-rest and source-websocket only.

Configuration for the WebSocket source.

Fields

url: String

WebSocket endpoint, ws:// or wss://. Supports {placeholder} parent-matrix context substitution.

auth: AuthSpec<WebsocketAuth>

Authentication applied to the HTTP upgrade request. Either inline ({ type, config }) or a { ref: <name> } pointer to a shared provider in the CLI’s top-level auth: catalog.

subscribe_messages: Vec<String>

Subscription frames sent (in order) immediately after every (re)connect. Empty = send nothing.

message_format: WsMessageFormat

How to interpret each incoming frame.

on_parse_error: OnParseError

In Json mode, what to do when a frame is not valid JSON.

envelope: bool

false (default) emits the record raw; true wraps it as { data, received_at, url }.

ping_interval: Option<Duration>

If set, send a WebSocket Ping frame on this interval (seconds) to keep the connection alive through proxies/load balancers.

max_messages: Option<usize>

Stop after this many messages. At least one of max_messages / idle_timeout must be set.

idle_timeout: Option<Duration>

Stop after this many seconds with no message. The idle clock keeps ticking across reconnect gaps, so it also caps a connection outage.

reconnect: bool

Reconnect on transport error / non-1000 close.

reconnect_backoff: Duration

Fixed wait (seconds) between reconnect attempts. Default 1s.

max_reconnect_attempts: Option<usize>

Cap on consecutive failed reconnects (resets on any received message). None = unlimited (then idle_timeout is the natural cap).

max_message_bytes: Option<usize>

Bound the max WebSocket message/frame size (bytes) to prevent runaway memory. None = tungstenite default (64 MiB message / 16 MiB frame).

batch_size: usize

Records per emitted StreamPage. Default DEFAULT_BATCH_SIZE. 0 drains the entire run window into a single page (same sentinel as the Kafka source).

Implementations

impl WebsocketSourceConfig

pub fn validate(&self) -> Result<(), FaucetError>

Validate the config at construction time. Called by WebsocketSource::new.

pub fn with_batch_size(self, batch_size: usize) -> WebsocketSourceConfig

Set the per-page record count for Source::stream_pages. Pass 0 to drain the entire run window into a single page.

Trait Implementations

impl Clone for WebsocketSourceConfig

fn clone(&self) -> WebsocketSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WebsocketSourceConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<WebsocketSourceConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for WebsocketSourceConfig

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 Serialize for WebsocketSourceConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.