Struct Room 

pub struct Room {
    pub(super) definition: RoomDefinition,
    pub(super) metrics: Arc<RuntimeMetrics>,
    source_policy_turn: Mutex<()>,
    pub(super) state: RwLock<RoomState>,
}

Fields

definition: RoomDefinition

metrics: Arc<RuntimeMetrics>

source_policy_turn: Mutex<()>

Serializes publication commits and activity changes with source-policy turns so their transport effects cannot overtake each other.

state: RwLock<RoomState>

Implementations

impl Room

pub(super) fn new(init: RoomInit) -> Self

pub(crate) fn user_operation<'a>( &'a self, user_id: &'a UserId, connection_id: ConnectionId, media_transport: &'a MediaTransport, ) -> RoomUserOperation<'a>

pub(super) async fn lock_source_policy(&self) -> SourcePolicyGuard<'_>

Serializes publication commits and effects with source-policy turns.

Call guarded operations while this guard is held. Acquiring another source-policy guard for this room before releasing it would deadlock.

pub fn uuid(&self) -> &str

pub fn issuer(&self) -> &str

pub fn key(&self) -> &SecretSlice<u8>

pub(crate) fn available_features(&self) -> AvailableFeatures

pub async fn recording_state(&self) -> RecordingState

pub(crate) async fn user_snapshots_except( &self, excluded_user_id: &UserId, ) -> Vec<PeerSnapshot>

pub fn web_rtc_enabled(&self) -> bool

pub async fn transport_user_key( &self, user_id: &UserId, connection_id: ConnectionId, ) -> TransportSessionKey

Returns the transport key for an exact committed router placement.

Panics

Panics when user_id and connection_id have no committed router placement.

pub fn room_worker_policy(&self) -> RoomWorkerPolicy

pub(crate) fn instance_id(&self) -> RoomInstanceId

impl Room

pub(super) async fn commit_admission( &self, admission: JoinAdmissionTurn<'_, impl FnOnce() -> RouterId>, context: RoomEffectContext<'_>, ) -> Result<JoinCommit, RoomJoinError>

Commits the admission turn with the room router.

Errors

Returns RoomJoinError::RoomFull when a new user exceeds capacity. Returns RoomJoinError::NoUsableWorker when no configured worker is usable. Returns RoomJoinError::RouterState when router placement cannot commit.

pub(super) async fn finalize_admission( &self, commit: JoinCommit, context: RoomEffectContext<'_>, ) -> CommittedTransportReceipt

Executes context-enabled RoomEffects before returning the committed receipt

pub(crate) async fn remove_user( &self, user_id: &UserId, connection_id: ConnectionId, media_transport: &MediaTransport, ) -> bool

Returns true only when connection_id removed the current room user.

pub async fn remove_user_with_teardown( &self, user_id: &UserId, connection_id: ConnectionId, context: RoomEffectContext<'_>, ) -> bool

Returns true only when connection_id was current. A stale committed placement may still be retired before returning false.

pub(crate) async fn broadcast( &self, sender_id: &UserId, connection_id: ConnectionId, message: Value, ) -> Result<(), BroadcastPayloadError>

Captures recipients in the state snapshot that validates connection_id as current for sender_id. Missing or stale senders are ignored.

Errors

Returns BroadcastPayloadError when the payload exceeds the room broadcast byte limit or cannot be measured as serialized JSON.

pub(crate) async fn has_connection( &self, user_id: &UserId, connection_id: ConnectionId, ) -> bool

pub(crate) async fn update_user_info( &self, user_id: &UserId, connection_id: ConnectionId, media_transport: &MediaTransport, info: UserInfo, )

Ignores missing or stale connections. Publication transitions remain authoritative for camera and screen-sharing presence.

pub(crate) async fn disconnect_users( &self, user_ids: &[UserId], media_transport: &MediaTransport, ) -> usize

Missing users are ignored.

Panics

Panics if a current room user has no committed router placement.

pub async fn disconnect_users_with_teardown( &self, user_ids: &[UserId], context: RoomEffectContext<'_>, ) -> usize

Removes current sessions in one state commit and ignores missing users.

Returns the number of sessions actually torn down.

Panics

Panics if a current room user has no committed router placement.

pub(super) async fn is_empty(&self) -> bool

impl Room

pub(crate) async fn session_stats_snapshot( &self, transport: &MediaTransport, ) -> RoomUserStatsSnapshot

pub async fn diagnostics_overview_capture(&self) -> RoomOverviewCapture

pub async fn diagnostics_users_capture(&self) -> RoomUsersCapture

pub async fn diagnostics_detail_capture(&self) -> RoomDetailCapture

pub async fn diagnostics_user_capture( &self, user_key: &str, ) -> Option<RoomUserCapture>

impl Room

pub(crate) fn apply_recording_start( &self, _user_id: &UserId, _connection_id: ConnectionId, _options: RecordingOptions, ) -> bool

pub(crate) fn apply_recording_stop( &self, _user_id: &UserId, _connection_id: ConnectionId, ) -> bool

impl Room

pub(in engine::room) async fn source_policy_worker_indices( &self, media_transport: &MediaTransport, ) -> Vec<usize>

Trait Implementations

impl Debug for Room

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

Formats the value using the given formatter.