Struct WebSocketClient

pub struct WebSocketClient { /* private fields */ }

Implementations

impl WebSocketClient

pub async fn connect_stream( url: String, headers: Vec<(String, String)>, heartbeat: Option<u64>, heartbeat_msg: Option<String>, max_reconnection_tries: Option<u64>, keyed_quotas: Vec<(String, Quota)>, default_quota: Option<Quota>, ) -> Result<(MessageReader, Self), Error>

Creates a websocket client that returns a stream for reading messages.

pub async fn connect( config: WebSocketConfig, post_connection: Option<PyObject>, post_reconnection: Option<PyObject>, post_disconnection: Option<PyObject>, keyed_quotas: Vec<(String, Quota)>, default_quota: Option<Quota>, ) -> Result<Self, Error>

Creates a websocket client.

Creates an inner client and controller task to reconnect or disconnect the client. Also assumes ownership of writer from inner client.

pub fn is_disconnected(&self) -> bool

pub async fn disconnect(&self)

Set disconnect mode to true.

Controller task will periodically check the disconnect mode and shutdown the client if it is alive

pub async fn send_text(&self, data: String) -> Result<(), Error>

pub async fn send_bytes(&self, data: Vec<u8>) -> Result<(), Error>

pub async fn send_close_message(&self)

Trait Implementations

impl IntoPy<Py<PyAny>> for WebSocketClient

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

Performs the conversion.

impl PyClass for WebSocketClient

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for WebSocketClient

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

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<'a, 'py> PyFunctionArgument<'a, 'py> for &'a WebSocketClient

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

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

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

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

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

impl PyMethods<WebSocketClient> for PyClassImplCollector<WebSocketClient>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for WebSocketClient

const NAME: &'static str = "WebSocketClient"

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_bound(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

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

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

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

Checks if object is an instance of this type.

impl DerefToPyAny for WebSocketClient