Skip to main content

Module outbound

Module outbound 

Source
Expand description

Bounded per-user room output.

UserOutboundSender::send enqueues without waiting and signals UserOutboundEvent::Overflow when message-count or byte capacity is exhausted. UserOutboundReceiver::recv_event prioritizes that signal over queued output. User-session loops must stop normal draining after overflow.

Structsยง

BroadcastPayload
JsonByteCounter ๐Ÿ”’
MessageFanout ๐Ÿ”’
QueuedUserOutbound ๐Ÿ”’
RemoteTrackProjection
RemoteTrackSnapshot
UserOutboundOverflow
queue overflow details captured when a user cannot accept more outbound work
UserOutboundQueueLimits
message and byte capacity for one user outbound queue
UserOutboundReceiver
UserOutboundSender
VersionedRemoteTrackSnapshot ๐Ÿ”’

Enumsยง

BroadcastPayloadError
RoomEventMessage
UserOutbound
room output that belongs to one connected user
UserOutboundEvent
receiver-side queue event for user-session loops
UserOutboundOverflowKind
outbound queue limit that rejected a message
UserOutboundSendError
non-blocking outbound send failure

Constantsยง

BROADCAST_QUEUE_OVERHEAD_BYTES ๐Ÿ”’
DEFAULT_USER_OUTBOUND_QUEUE_BYTE_CAPACITY
DEFAULT_USER_OUTBOUND_QUEUE_CAPACITY
MAX_BROADCAST_PAYLOAD_BYTES
ROOM_EVENT_QUEUE_BYTES ๐Ÿ”’
TRACK_PROJECTION_QUEUE_OVERHEAD_BYTES ๐Ÿ”’

Functionsยง

fanout_all ๐Ÿ”’
serialized_json_len ๐Ÿ”’
wait_for_overflow ๐Ÿ”’

Type Aliasesยง

OutboundSender ๐Ÿ”’