Struct WebSocket 

pub struct WebSocket { /* private fields */ }

RFC 6455 WebSocket client.

Implementations

impl WebSocket

pub fn connect( host: &str, port: u16, path: &str, use_tls: bool, ) -> Result<Self, NetworkError>

Open a WebSocket connection to ws://host:port/path (plain) or wss://host:port/path (TLS).

Errors

Returns NetworkError::ConnectFailed on failure.

pub fn send_text(&self, text: &str) -> Result<(), NetworkError>

Send a UTF-8 text message.

Errors

Returns NetworkError::SendFailed.

pub fn send_binary(&self, data: &[u8]) -> Result<(), NetworkError>

Send a binary message.

Errors

Returns NetworkError::SendFailed.

pub fn send_ping(&self, payload: &[u8]) -> Result<(), NetworkError>

Send a ping (with optional payload).

Errors

Returns NetworkError::SendFailed.

pub fn send(&self, data: &[u8], opcode: Opcode) -> Result<(), NetworkError>

Generic send.

Errors

Returns NetworkError::SendFailed.

pub fn receive(&self, max_len: usize) -> Result<WsMessage, NetworkError>

Receive one WebSocket message (blocking up to max_len bytes).

Errors

Returns NetworkError::ReceiveFailed.

pub unsafe fn set_pong_handler( &self, metadata: *mut c_void, callback: WsPongCallback, ) -> Result<(), NetworkError>

Register a pong handler callback for WebSocket messages.

This registers a callback that will be invoked whenever a pong frame is received. The callback will receive a crate::FrameworkError if there was an error processing the pong, or None if the pong was handled successfully.

Safety

• The callback must be safe to call from the networking dispatch queue.
• The provided metadata must be valid WebSocket protocol metadata.
• The metadata pointer must remain valid while the callback is in use.

Errors

Returns NetworkError::InvalidArgument if metadata is null.

pub unsafe fn set_pong_handler_with_context( &self, metadata: *mut c_void, callback: WsPongCallback, user_info: *mut c_void, ) -> Result<(), NetworkError>

Register a pong handler with user context.

Similar to Self::set_pong_handler but allows passing user context that will be forwarded to the callback.

Safety

• The callback must be safe to call from the networking dispatch queue.
• The provided metadata must be valid WebSocket protocol metadata.
• The metadata and user_info pointers must remain valid while the callback is in use.

Errors

Returns NetworkError::InvalidArgument if metadata is null.

Trait Implementations

impl Debug for WebSocket

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

Formats the value using the given formatter.

impl Drop for WebSocket

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.

impl Send for WebSocket

impl Sync for WebSocket