Struct WebSocketConfig 

pub struct WebSocketConfig {
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub heartbeat: Option<u64>,
    pub heartbeat_msg: Option<String>,
    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>,
    pub reconnect_max_attempts: Option<u32>,
    pub idle_timeout_ms: Option<u64>,
}

Configuration for WebSocket client connections.

This struct contains only static configuration settings. Runtime callbacks (message handler, ping handler) are passed separately to connect().

Connection Modes

Handler Mode

• Use with crate::websocket::WebSocketClient::connect.
• Pass a message handler to connect() to receive messages via callback.
• 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

• Use with crate::websocket::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.

heartbeat: Option<u64>

The optional heartbeat interval (seconds).

heartbeat_msg: Option<String>

The optional heartbeat message.

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.

reconnect_max_attempts: Option<u32>

The maximum number of reconnection attempts before giving up. Note: Only applies to handler mode. Ignored in stream mode.

• None: Unlimited reconnection attempts (default, recommended for production).
• Some(n): After n failed attempts, transition to CLOSED state.

idle_timeout_ms: Option<u64>

The idle timeout (milliseconds) for the read task. When set, the read task will break and trigger reconnection if no data is received within this duration. Useful for detecting silently dead connections where the server stops sending without closing. Note: Only applies to handler mode. Ignored in stream mode.

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<'a, 'py> FromPyObject<'a, 'py> for WebSocketConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

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

const NAME: &str = "WebSocketConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for WebSocketConfig

const MODULE: Option<&str>

Module which the class will be associated with.

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. /// /// This struct contains only static configuration settings. Runtime callbacks /// (message handler, ping handler) are passed separately to `connect()`. /// /// # Connection Modes /// /// ## Handler Mode /// /// - Use with [`crate::websocket::WebSocketClient::connect`]. /// - Pass a message handler to `connect()` to receive messages via callback. /// - 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 /// /// - Use with [`crate::websocket::WebSocketClient::connect_stream`]. /// - Returns a [`MessageReader`](super::types::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 Layout = <<WebSocketConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<WebSocketConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for WebSocketConfig

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

impl PyMethods<WebSocketConfig> for PyClassImplCollector<WebSocketConfig>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for WebSocketConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0: prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0: prefer using ::type_object(py).module() to get the correct runtime value

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