Struct RoomClient 

pub struct RoomClient {
    pub namespace: String,
    pub room_id: String,
    /* private fields */
}

Fields

namespace: String

Room namespace (e.g. “game”, “chat”)

room_id: String

Room instance ID within the namespace

Implementations

impl RoomClient

pub fn new( base_url: &str, namespace: &str, room_id: &str, token_fn: impl Fn() -> String + Send + Sync + 'static, opts: Option<RoomOptions>, ) -> Arc<Self>

Create a new v2 RoomClient.

Arguments

• base_url - EdgeBase server URL (http or https)
• namespace - Room namespace (e.g. “game”, “chat”)
• room_id - Room instance ID within the namespace
• token_fn - Closure that returns the current access token
• opts - Optional RoomOptions for reconnect and timeout configuration

pub fn get_shared_state(&self) -> Value

Get current shared state (read-only snapshot).

pub fn get_player_state(&self) -> Value

Get current player state (read-only snapshot).

pub fn list_members(&self) -> Value

Get the current logical room members snapshot.

pub fn list_media_members(&self) -> Value

Get the current media member snapshot.

pub fn connection_state(&self) -> String

Get the current session connection state.

pub fn state(self: &Arc<Self>) -> RoomStateNamespace

pub fn meta(self: &Arc<Self>) -> RoomMetaNamespace

pub fn signals(self: &Arc<Self>) -> RoomSignalsNamespace

pub fn members(self: &Arc<Self>) -> RoomMembersNamespace

pub fn admin(self: &Arc<Self>) -> RoomAdminNamespace

pub fn media(self: &Arc<Self>) -> RoomMediaNamespace

pub fn session(self: &Arc<Self>) -> RoomSessionNamespace

pub async fn get_metadata(&self) -> Result<Value, Error>

Get room metadata without joining (HTTP GET). Returns developer-defined metadata set by room.setMetadata() on the server.

pub async fn get_metadata_static( base_url: &str, namespace: &str, room_id: &str, ) -> Result<Value, Error>

Static: Get room metadata without creating a RoomClient instance. Useful for lobby screens where you need room info before joining.

pub async fn join(self: &Arc<Self>) -> Result<(), Error>

Connect to the room, authenticate, and join.

pub async fn leave(&self)

Leave the room and disconnect. Cleans up all pending send() requests.

pub async fn send( &self, action_type: &str, payload: Option<Value>, ) -> Result<Value, Error>

Send an action to the server. Returns a Result that resolves with the action result from the server.

Example

let result = room.send("SET_SCORE", Some(json!({"score": 42}))).await?;

pub fn on_shared_state( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

Subscribe to shared state changes. Handler receives (full_state, changes) on each sync/delta.

pub fn on_player_state( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

Subscribe to player state changes. Handler receives (full_state, changes) on each sync/delta.

pub fn on_message( &self, msg_type: &str, handler: impl Fn(&Value) + Send + Sync + 'static, ) -> Subscription

Subscribe to messages of a specific type sent by room.sendMessage().

Example

let sub = room.on_message("game_over", |data| { println!("{:?}", data); });

pub fn on_error( &self, handler: impl Fn(&str, &str) + Send + Sync + 'static, ) -> Subscription

Subscribe to error events.

pub fn on_kicked( &self, handler: impl Fn() + Send + Sync + 'static, ) -> Subscription

Subscribe to kick events. After being kicked, auto-reconnect is disabled.

pub fn on_members_sync( &self, handler: impl Fn(&Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_member_join( &self, handler: impl Fn(&Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_member_leave( &self, handler: impl Fn(&Value, &str) + Send + Sync + 'static, ) -> Subscription

pub fn on_member_state_change( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_signal( &self, event: &str, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_any_signal( &self, handler: impl Fn(&str, &Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_media_track( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_media_track_removed( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_media_state_change( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_media_device_change( &self, handler: impl Fn(&Value, &Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_reconnect( &self, handler: impl Fn(&Value) + Send + Sync + 'static, ) -> Subscription

pub fn on_connection_state_change( &self, handler: impl Fn(&str) + Send + Sync + 'static, ) -> Subscription

pub async fn send_signal( &self, event: &str, payload: Option<Value>, options: Option<Value>, ) -> Result<(), Error>

pub async fn send_member_state(&self, state: Value) -> Result<(), Error>

pub async fn clear_member_state(&self) -> Result<(), Error>

pub async fn send_admin( &self, operation: &str, member_id: &str, payload: Option<Value>, ) -> Result<(), Error>

pub async fn send_media( &self, operation: &str, kind: &str, payload: Option<Value>, ) -> Result<(), Error>

pub async fn switch_media_devices(&self, payload: Value) -> Result<(), Error>

pub async fn destroy(self: &Arc<Self>)

Leave the room, clear all handler lists, and release resources. After calling destroy(), this RoomClient instance should not be reused.