Struct WebSocketConfig

pub struct WebSocketConfig {
    pub url: String,
    pub headers: Vec<(String, String)>,
    pub handler: Option<Arc<PyObject>>,
    pub heartbeat: Option<u64>,
    pub heartbeat_msg: Option<String>,
    pub ping_handler: Option<Arc<PyObject>>,
    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>,
}

Fields

url: String

The URL to connect to.

headers: Vec<(String, String)>

The default headers.

handler: Option<Arc<PyObject>>

The Python function to handle incoming messages.

heartbeat: Option<u64>

The optional heartbeat interval (seconds).

heartbeat_msg: Option<String>

The optional heartbeat message.

ping_handler: Option<Arc<PyObject>>

The handler for incoming pings.

reconnect_timeout_ms: Option<u64>

The timeout (milliseconds) for reconnection attempts.

reconnect_delay_initial_ms: Option<u64>

The initial reconnection delay (milliseconds) for reconnects.

reconnect_delay_max_ms: Option<u64>

The maximum reconnect delay (milliseconds) for exponential backoff.

reconnect_backoff_factor: Option<f64>

The exponential backoff factor for reconnection delays.

reconnect_jitter_ms: Option<u64>

The maximum jitter (milliseconds) added to reconnection delays.

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> WebSocketConfig

Returns a copy 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 IntoPy<Py<PyAny>> for WebSocketConfig

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

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)]

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<WebSocketConfig> for PyClassImplCollector<WebSocketConfig>

fn new_text_signature(self) -> Option<&'static str>

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

type Holder = Option<PyRef<'py, WebSocketConfig>>

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

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

type Holder = Option<PyRefMut<'py, WebSocketConfig>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a 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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for [PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for [PyTypeInfo::is_type_of].

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for [PyTypeInfo::is_exact_type_of].

impl DerefToPyAny for WebSocketConfig