Struct WsSession 

pub struct WsSession {
    pub rx: Arc<Mutex<Receiver<HandlerMessage>>>,
    pub tx: Arc<Sender<HandlerMessage>>,
    pub ws_stream: Arc<Mutex<WebSocketStream<MaybeTlsStream<TcpStream>>>>,
}

A WebSocket session client for the OpenAI Realtime API.

Manages the WebSocket connection, sending and receiving messages, and handling events.

Fields

rx: Arc<Mutex<Receiver<HandlerMessage>>>

Receiver for messages from the WebSocket.

tx: Arc<Sender<HandlerMessage>>

Sender for messages to the WebSocket.

ws_stream: Arc<Mutex<WebSocketStream<MaybeTlsStream<TcpStream>>>>

The WebSocket stream.

Implementations

impl WsSession

pub async fn connect(url: &str) -> Result<Self>

Creates a new WsSession and connects to the specified URL.

Arguments

• url: The WebSocket URL to connect to.

Errors

Returns OpenAIError::Ws if the connection fails.

pub async fn send_event(&self, event: RealtimeClientEvent) -> Result<()>

Sends a client event message over the WebSocket.

Arguments

• event: The RealtimeClientEvent to send.

Errors

Returns OpenAIError::Internal if serialization or sending fails.

pub async fn recv_event(&self) -> Result<RealtimeServerEvent>

Receives a server event message from the WebSocket.

Errors

Returns OpenAIError::Internal if deserialization fails or if the channel is closed.

Trait Implementations

impl Clone for WsSession

fn clone(&self) -> WsSession

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WsSession

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

Formats the value using the given formatter.