Struct RoomEffects 

pub struct RoomEffects {
    policy_before_transport: bool,
    transport: RoomTransportPlan,
    output: RoomOutputPlan,
    source_policy: SourcePolicyTurn,
}

batches post-lock transport, signaling and policy side-effects for room state transitions

room state mutation (holds RoomState write lock)
  - mutate in-memory graph
  - return commit data
            |
            v  drop RoomState write lock
RoomEffects::from_*(commit) -> execute_inner
            |
            v  step 1: transport execution
  +-----------------------------------------------------------+
  | - create/remove local consumer routes on workers          |
  | - register/remove cross-worker relay route targets        |
  | - dispatch session teardowns                              |
  +-----------------------------------------------------------+
            |
            v  step 2: RoomOutputPlan pre-policy fanout
  +-----------------------------------------------------------+
  | - send track snapshots and presence user-info fanout      |
  +-----------------------------------------------------------+
            |
            v  step 3: source policy turn
  +-----------------------------------------------------------+
  | - re-evaluate audio admission and video bandwidth solver  |
  | - commit packet gate and BWE target updates               |
  +-----------------------------------------------------------+
            |
            v  step 4: RoomOutputPlan post-policy fanout
  +-----------------------------------------------------------+
  | - send user-info and lifecycle close/track/fanout output  |
  +-----------------------------------------------------------+

The diagram shows the normal batch order. Only an active ProducerActivityCommit from from_publication_activity runs its pre-policy user-info output and source policy before transport. Callers of from_publish and from_publication_activity use execute_with_source_policy_guard while holding source_policy_turn.

Fields

policy_before_transport: bool

transport: RoomTransportPlan

output: RoomOutputPlan

source_policy: SourcePolicyTurn

Implementations

impl RoomEffects

pub(in engine::room) fn from_join( commit: JoinCommit, ) -> Self

pub(in engine::room) fn from_connection_close( commit: ConnectionCloseCommit, ) -> Self

pub(in engine::room) fn from_disconnect( commit: DisconnectCommit, ) -> Self

pub(in engine::room) fn from_presence( commit: PresenceCommit, ) -> Self

pub(in engine::room) fn from_publish( commit: PublishCommit, ) -> Self

pub(in engine::room) fn from_publication_activity( commit: ProducerActivityCommit, ) -> Self

pub(in engine::room) fn from_receiver_intent( commit: ReceiverRouteCommit, ) -> Self

pub(in engine::room) fn from_consumer_readiness( commit: ReceiverRouteCommit, ) -> Self

fn push_presence_before_policy(&mut self, presence: Option<PresenceCommit>)

fn from_receiver_route( work: ReceiverRouteWork, origin: ConsumerSetupOrigin, ) -> Self

pub async fn execute(self, room: &Room, context: RoomEffectContext<'_>)

preserves the room-wide side-effect order across transport and policy work

pub(in engine::room) async fn execute_with_source_policy_guard( self, room: &Room, context: RoomEffectContext<'_>, )

async fn execute_inner( self, room: &Room, context: RoomEffectContext<'_>, source_policy_guarded: bool, )

Trait Implementations

impl Debug for RoomEffects

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

Formats the value using the given formatter.

impl Default for RoomEffects

fn default() -> RoomEffects

Returns the “default value” for a type.