Struct WebSocketClientInner 

pub struct WebSocketClientInner { /* private fields */ }

WebSocketClient connects to a websocket server to read and send messages.

The client is opinionated about how messages are read and written. It assumes that data can only have one reader but multiple writers.

The client splits the connection into read and write halves. It moves the read half into a tokio task which keeps receiving messages from the server and calls a handler - a Python function that takes the data as its parameter. It stores the write half in the struct wrapped with an Arc Mutex. This way the client struct can be used to write data to the server from multiple scopes/tasks.

The client also maintains a heartbeat if given a duration in seconds. It’s preferable to set the duration slightly lower - heartbeat more frequently - than the required amount.

Implementations

impl WebSocketClientInner

pub async fn new_with_writer( config: WebSocketConfig, writer: SplitSink<BoxedWsTransport, Message>, ) -> Result<Self, TransportError>

Create an inner websocket client with an existing writer.

This is used for stream mode where the reader is owned by the caller.

Errors

Returns an error if the exponential backoff configuration is invalid.

pub async fn connect_url( config: WebSocketConfig, message_handler: Option<MessageHandler>, ping_handler: Option<PingHandler>, ) -> Result<Self, TransportError>

Create an inner websocket client.

Errors

Returns an error if:

• The connection to the server fails.
• The exponential backoff configuration is invalid.

pub async fn connect_with_server( url: &str, headers: Vec<(String, String)>, backend: TransportBackend, proxy_url: Option<&str>, ) -> Result<(SplitSink<BoxedWsTransport, Message>, MessageReader), TransportError>

Connect to the server and return the split halves of the active transport.

Dispatches on backend to the matching backend helper. The TransportBackend::Tungstenite backend is always available; the TransportBackend::Sockudo backend requires the transport-sockudo Cargo feature (enabled by default) and uses a custom HTTP/1.1 handshake path for upgrade headers.

When proxy_url is Some, the Tungstenite backend establishes an HTTP CONNECT tunnel through the proxy before performing the WebSocket handshake. The Sockudo backend does not yet support proxying; when it is selected together with a proxy URL, this method logs a warning and transparently falls back to Tungstenite so omitted-backend Python configurations keep working.

Errors

Returns a TransportError if the URL is invalid, headers fail to parse, the TCP / TLS layer cannot be established, the proxy refuses the tunnel, or the WebSocket handshake is rejected by the peer. When the Sockudo backend is selected without the transport-sockudo feature, returns TransportError::Other.

impl WebSocketClientInner

pub async fn reconnect(&mut self) -> Result<(), TransportError>

Reconnect with server.

Make a new connection with server. Use the new read and write halves to update self writer and read and heartbeat tasks.

For stream-based clients (created via connect_stream), reconnection is disabled because the reader is owned by the caller and cannot be replaced. Stream users should handle disconnections by creating a new connection.

The reconnect timeout bounds only connection establishment. Once the new writer is handed to the writer task the swap runs to completion, so buffered messages can never drain into a connection that lost its reader to a timeout; the post-connect steps are individually bounded by the writer task’s graceful-shutdown timeout.

Errors

Returns an error if:

• The reconnection attempt times out.
• The connection to the server fails.

pub fn is_alive(&self) -> bool

Check if the client is still alive.

Returns true if both the read and write tasks are still running. There may be some delay between the connection closing and the client detecting it.

Trait Implementations

impl CleanDrop for WebSocketClientInner

Cleanup on drop: aborts background tasks and clears handlers to break reference cycles.

fn clean_drop(&mut self)

Perform custom cleanup, releasing external resources and breaking strong reference cycles.

impl Debug for WebSocketClientInner

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Drop for WebSocketClientInner

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.