Struct WebSocketConfig 

pub struct WebSocketConfig {
    pub url: String,
    pub path: Option<String>,
    pub message_id_header: Option<String>,
    pub routed_queue_capacity: Option<usize>,
    pub backlog: Option<u32>,
    pub execution_mode: WebSocketExecutionMode,
}

WebSocket connection configuration.

Fields

url: String

For consumers, the listen address (e.g. “0.0.0.0:9000”). For publishers, the target URL.

path: Option<String>

(Consumer only) Optional request path filter. If set, only upgrade requests whose URI path matches exactly are delivered to this consumer.

message_id_header: Option<String>

(Consumer only) Header key to extract the message ID from the WebSocket handshake. Defaults to “message-id”.

routed_queue_capacity: Option<usize>

(Consumer only) Queue capacity for the routed adapter. Direct response routes do not use this queue. Defaults to 100.

backlog: Option<u32>

(Consumer only) TCP listen backlog (pending-connection queue depth) for the accept socket. Raise this if high-concurrency handshake bursts are being dropped/reset before accept() can keep up. Defaults to 4096, which is higher than the OS/tokio default of 1024.

execution_mode: WebSocketExecutionMode

(Consumer only) Selects whether WebSocket routes run directly or through the routed pipeline.

Implementations

impl WebSocketConfig

pub fn new(url: impl Into<String>) -> Self

Creates a new WebSocket configuration with the specified URL.

pub fn with_path(self, path: impl Into<String>) -> Self

pub fn with_backlog(self, backlog: u32) -> Self

pub fn with_execution_mode(self, execution_mode: WebSocketExecutionMode) -> Self

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> WebSocketConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketConfig

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

Formats the value using the given formatter.

impl Default for WebSocketConfig

fn default() -> WebSocketConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSocketConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl SecretExtractor for WebSocketConfig

fn extract_secrets( &mut self, prefix: &str, secrets: &mut HashMap<String, String>, )

Extracts secrets into the provided map using the given prefix, and clears them from self.

impl Serialize for WebSocketConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.