Struct caesar_core::relay::client::Client

pub struct Client {
    sender: Arc<Mutex<SplitSink<WebSocket, Message>>>,
    room_id: Option<String>,
}

Struct representing a WebSocket client.

This struct contains a WebSocket sender and an optional room ID. The sender is used to send messages to the WebSocket connection, while the room ID is used to identify the client’s room.

Fields

sender: Arc<Mutex<SplitSink<WebSocket, Message>>>

The WebSocket sender for sending messages.

room_id: Option<String>

The optional room ID of the client.

This is used to identify the client’s room.

Implementations

impl Client

pub fn new(sender: Arc<Mutex<SplitSink<WebSocket, Message>>>) -> Client

Creates a new WebSocket client.

Arguments

• sender - A synchronized WebSocket sender.

Returns

A new WebSocket client instance.

async fn send( &self, sender: Arc<Mutex<SplitSink<WebSocket, Message>>>, message: Message )

Sends a message to the WebSocket connection.

Arguments

• sender - A synchronized WebSocket sender.
• message - The message to send.

Errors

If the message fails to be sent.

async fn send_packet( &self, sender: Arc<Mutex<SplitSink<WebSocket, Message>>>, packet: ResponsePacket )

Sends a serialized packet to the WebSocket connection.

Arguments

• sender - A synchronized WebSocket sender.
• packet - The packet to send.

Errors

If the serialized packet fails to be sent.

async fn send_error_packet( &self, sender: Arc<Mutex<SplitSink<WebSocket, Message>>>, message: String )

Sends an error message to the WebSocket connection.

Arguments

• sender - A synchronized WebSocket sender.
• message - The error message to send.

Errors

If the error message fails to be sent.

async fn handle_create_room( &mut self, server: &RwLock<AppState>, id: Option<String> )

Handles the “create_room” request from a client.

Arguments

• server - A lock guard of the AppState.
• id - An optional string representing the room identifier.

Errors

If the room already exists or if the room creation fails.

async fn handle_join_room(&mut self, server: &RwLock<AppState>, room_id: String)

Handles the “join_room” request from a client.

Arguments

• server - A lock guard of the AppState.
• room_id - A string representing the room identifier.

Errors

If the room does not exist or if the room is full.

async fn handle_leave_room(&mut self, server: &RwLock<AppState>)

Handle the leave room request from the client.

This function removes the client from the current room and notifies the other clients in the room about the client’s departure.

Arguments

• server - A read-write lock guard for the server state.

Returns

This function does not return anything.

pub async fn handle_message( &mut self, server: &RwLock<AppState>, message: Message )

Handles incoming messages from the client.

This function interprets the incoming message and performs the corresponding action.

Arguments

• server - A RwLock guard containing the state of the server.
• message - The incoming message from the client.

pub async fn handle_close(&mut self, server: &RwLock<AppState>)

Trait Implementations

impl Debug for Client

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

Formats the value using the given formatter.