Struct WebSocketConfig 

pub struct WebSocketConfig {
    pub url: String,
    pub connect_timeout: Duration,
    pub ping_interval: Duration,
    pub pong_timeout: Duration,
    pub max_message_size: usize,
    pub auto_reconnect: bool,
    pub max_reconnect_attempts: u32,
    pub reconnect_backoff: ExponentialBackoff,
    pub subprotocols: Vec<String>,
    pub headers: Vec<(String, String)>,
    pub allowed_origins: Vec<String>,
}

Configuration for WebSocket transport.

Fields

url: String

WebSocket URL (ws:// or wss://).

connect_timeout: Duration

Connection timeout.

ping_interval: Duration

Ping interval for keeping the connection alive.

pong_timeout: Duration

Pong timeout (how long to wait for pong after sending ping).

max_message_size: usize

Maximum message size in bytes.

auto_reconnect: bool

Whether to enable automatic reconnection.

max_reconnect_attempts: u32

Maximum reconnection attempts.

reconnect_backoff: ExponentialBackoff

Reconnection backoff configuration.

subprotocols: Vec<String>

Additional WebSocket subprotocols.

headers: Vec<(String, String)>

Custom headers for the WebSocket handshake.

allowed_origins: Vec<String>

Allowed origins for DNS rebinding protection (server-side). If empty, origin validation is disabled.

Implementations

impl WebSocketConfig

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

Create a new WebSocket configuration.

pub fn with_allowed_origin(self, origin: impl Into<String>) -> Self

Add an allowed origin for DNS rebinding protection.

When origins are configured, the server will reject WebSocket connections from origins not in the list. This helps prevent DNS rebinding attacks.

Example

use mcpkit_transport::websocket::WebSocketConfig;

let config = WebSocketConfig::new("ws://localhost:8080/mcp")
    .with_allowed_origin("https://trusted-app.com")
    .with_allowed_origin("https://another-trusted-app.com");

pub fn with_allowed_origins( self, origins: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set multiple allowed origins at once.

pub fn is_origin_allowed(&self, origin: &str) -> bool

Check if an origin is allowed.

Returns true if:

• No origins are configured (origin validation disabled)
• The origin is in the allowed list

pub const fn with_connect_timeout(self, timeout: Duration) -> Self

Set the connection timeout.

pub const fn with_ping_interval(self, interval: Duration) -> Self

Set the ping interval.

pub const fn with_pong_timeout(self, timeout: Duration) -> Self

Set the pong timeout.

pub const fn with_max_message_size(self, size: usize) -> Self

Set the maximum message size.

pub const fn without_auto_reconnect(self) -> Self

Disable automatic reconnection.

pub const fn with_max_reconnect_attempts(self, attempts: u32) -> Self

Set maximum reconnection attempts.

pub fn with_subprotocol(self, protocol: impl Into<String>) -> Self

Add a WebSocket subprotocol.

pub fn with_header( self, name: impl Into<String>, value: impl Into<String>, ) -> Self

Add a custom header for the WebSocket handshake.

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() -> Self

Returns the “default value” for a type.