Struct WebSocketConfig 

pub struct WebSocketConfig {
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub message_handler: Option<MessageHandler>,
    pub heartbeat: Option<u64>,
    pub heartbeat_msg: Option<String>,
    pub ping_handler: Option<PingHandler>,
    pub reconnect_timeout_ms: Option<u64>,
    pub reconnect_delay_initial_ms: Option<u64>,
    pub reconnect_delay_max_ms: Option<u64>,
    pub reconnect_backoff_factor: Option<f64>,
    pub reconnect_jitter_ms: Option<u64>,
}

Configuration for WebSocket client connections.

Connection Modes

The message_handler field determines the connection mode:

Handler Mode (message_handler: Some(...))

• Use with WebSocketClient::connect.
• Client spawns internal task to read messages and call handler.
• Supports automatic reconnection with exponential backoff.
• Reconnection config fields (reconnect_*) are active.
• Best for long-lived connections, Python bindings, callback-based APIs.

Stream Mode (message_handler: None)

• Use with WebSocketClient::connect_stream.
• Returns a MessageReader stream for the caller to read from.
• Does NOT support automatic reconnection (reader owned by caller).
• Reconnection config fields are ignored.
• On disconnect, client transitions to CLOSED state and caller must manually reconnect.

Fields

url: String

The URL to connect to.

headers: Vec<(String, String)>

The default headers.

message_handler: Option<MessageHandler>

The function to handle incoming messages.

• Some(handler): Handler mode with automatic reconnection (use with connect).
• None: Stream mode without automatic reconnection (use with connect_stream).

See WebSocketConfig docs for detailed explanation of modes.

heartbeat: Option<u64>

The optional heartbeat interval (seconds).

heartbeat_msg: Option<String>

The optional heartbeat message.

ping_handler: Option<PingHandler>

The handler for incoming pings.

reconnect_timeout_ms: Option<u64>

The timeout (milliseconds) for reconnection attempts.

Note: Only applies to handler mode. Ignored in stream mode.

reconnect_delay_initial_ms: Option<u64>

The initial reconnection delay (milliseconds) for reconnects.

Note: Only applies to handler mode. Ignored in stream mode.

reconnect_delay_max_ms: Option<u64>

The maximum reconnect delay (milliseconds) for exponential backoff.

Note: Only applies to handler mode. Ignored in stream mode.

reconnect_backoff_factor: Option<f64>

The exponential backoff factor for reconnection delays.

Note: Only applies to handler mode. Ignored in stream mode.

reconnect_jitter_ms: Option<u64>

The maximum jitter (milliseconds) added to reconnection delays.

Note: Only applies to handler mode. Ignored in stream mode.

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> Self

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<'py> IntoPyObject<'py> for WebSocketConfig

type Target = WebSocketConfig

The Python output type

type Output = Bound<'py, <WebSocketConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for WebSocketConfig

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for WebSocketConfig

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for WebSocket client connections. /// /// # Connection Modes /// /// The `message_handler` field determines the connection mode: /// /// ## Handler Mode (`message_handler: Some(...)`) /// - Use with [`WebSocketClient::connect`]. /// - Client spawns internal task to read messages and call handler. /// - **Supports automatic reconnection** with exponential backoff. /// - Reconnection config fields (`reconnect_*`) are active. /// - Best for long-lived connections, Python bindings, callback-based APIs. /// /// ## Stream Mode (`message_handler: None`) /// - Use with [`WebSocketClient::connect_stream`]. /// - Returns a [`MessageReader`] stream for the caller to read from. /// - **Does NOT support automatic reconnection** (reader owned by caller). /// - Reconnection config fields are ignored. /// - On disconnect, client transitions to CLOSED state and caller must manually reconnect.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<WebSocketConfig>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for WebSocketConfig

const TEXT_SIGNATURE: &'static str = "(url, handler, headers, heartbeat=None, heartbeat_msg=None, ping_handler=None, reconnect_timeout_ms=10000, reconnect_delay_initial_ms=2000, reconnect_delay_max_ms=30000, reconnect_backoff_factor=1.5, reconnect_jitter_ms=100)"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder WebSocketConfig

type Holder = Option<PyClassGuard<'a, WebSocketConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut WebSocketConfig

type Holder = Option<PyClassGuardMut<'a, WebSocketConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<WebSocketConfig> for PyClassImplCollector<WebSocketConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for WebSocketConfig

const NAME: &'static str = "WebSocketConfig"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for WebSocketConfig