Skip to main content

Module room

Module room 

Source
Expand description

Room lifecycle, membership and media-route orchestration.

RoomManager publishes current rooms and coordinates admission, worker placement and empty-room removal. Each Room coordinates membership, the desired media_graph and per-user outbound signaling.

State transitions capture post-lock transport effects. source_policy recomputes route activity and packet selection from room and transport snapshots after state changes or coalesced policy wakeups. read_model captures room facts for diagnostics before they are combined with transport snapshots.

Re-exportsยง

pub use factory::RoomAdmissionPolicy;
pub use factory::RoomConfig;
pub use factory::RoomRuntimePolicy;
pub use instance::Room;
pub use instance::RoomJoinError;
pub use instance::RoomManagerJoinError;
pub use instance::RoomManagerServeError;
pub use instance::RoomMediaCounts;
pub use manager::RoomManager;
pub use manager::RoomUserAdmission;
pub use manager::RuntimeRoomDirectorySnapshot;
pub use manager::RuntimeRoomStatsSnapshot;
pub use membership::JoinUserRequest;
pub use membership::RoomUserPermissions;
pub use membership::UserCloseReason;
pub use outbound::BroadcastPayload;
pub use outbound::BroadcastPayloadError;
pub use outbound::DEFAULT_USER_OUTBOUND_QUEUE_BYTE_CAPACITY;
pub use outbound::DEFAULT_USER_OUTBOUND_QUEUE_CAPACITY;
pub use outbound::MAX_BROADCAST_PAYLOAD_BYTES;
pub use outbound::RemoteTrackProjection;
pub use outbound::RemoteTrackSnapshot;
pub use outbound::RoomEventMessage;
pub use outbound::UserOutbound;
pub use outbound::UserOutboundEvent;
pub use outbound::UserOutboundOverflow;
pub use outbound::UserOutboundOverflowKind;
pub use outbound::UserOutboundQueueLimits;
pub use outbound::UserOutboundReceiver;
pub use outbound::UserOutboundSendError;
pub use outbound::UserOutboundSender;
pub use placement::RoomRuntimeContext;
pub use read_model::IncomingBitrateSnapshot;
pub use read_model::RoomDetailCapture;
pub use read_model::RoomOverviewCapture;
pub use read_model::RoomUserCapture;
pub use read_model::RoomUserStatsSnapshot;
pub use read_model::RoomUsersCapture;

Modulesยง

definition ๐Ÿ”’
Room identity and immutable runtime policy.
directory ๐Ÿ”’
Current-room indexes and lifecycle leases.
effects ๐Ÿ”’
shared post-lock effect batch executor for room transitions
factory ๐Ÿ”’
Room construction for rooms that are new to the runtime directory.
instance ๐Ÿ”’
manager ๐Ÿ”’
Current-room registry and lifecycle coordinator.
media_graph ๐Ÿ”’
membership ๐Ÿ”’
Membership commit and effect boundary.
outbound ๐Ÿ”’
Bounded per-user room output.
placement ๐Ÿ”’
Router and packet-worker placement for room admission.
read_model ๐Ÿ”’
Two-phase room diagnostics.
recording ๐Ÿ”’
source_policy ๐Ÿ”’
Per-room audio admission and receiver-video allocation.
state ๐Ÿ”’
transition ๐Ÿ”’

Structsยง

RouterPlacement
RouterPlacements

Enumsยง

RouterPlacementsError