Struct SocketIo

pub struct SocketIo { /* private fields */ }

SocketIo manages WebSocket communication for handling RPC events.

It utilizes WebSocket technology to facilitate real-time communication, providing mechanisms for sending requests and receiving responses.

Additionally, it supports RPC cancellation and timeout functionality, allowing for better control over ongoing operations.

The struct efficiently manages concurrent RPC events and notifies clients of relevant occurrences.

Implementations

impl SocketIo

pub fn notifier(&self) -> Notifier

Returns a Notifier for sending notifications.

pub async fn notify( &mut self, name: &str, data: impl AsRef<[u8]>, ) -> Result<(), NotifyError>

Sends a notification with the given name and data.

pub fn new<I, O>(reader: I, writer: O, buffer: usize) -> Self

where I: Unpin + AsyncRead + Send + 'static, O: Unpin + AsyncWrite + Send + 'static,

Creates a new SocketIo instance with the specified reader, writer, and buffer size.

Arguments

• reader - The source for reading data.
• writer - The destination for writing data.
• buffer - The size of the buffer for the channel.

pub async fn recv(&mut self) -> Result<Procedure>

Receives the next Procedure (either a rpc or notification).

Connection State

• Returns io::ErrorKind::ConnectionReset when an error event occurs.
• Returns io::ErrorKind::ConnectionAborted when a close event is received.