Skip to main content

Module wire

Module wire 

Source
Expand description

JSON wire envelopes and signaling payloads

this facade contains the serialized protocol contract exchanged over the WebSocket browser and native hosts should share these types instead of duplicating envelope names or request payload shapes

String user identities are limited to 256 decoded UTF-8 bytes by crate::wire::UserId::MAX_STRING_BYTES. This limit applies to native clients as well as browser clients, including authentication claims and subscription targets. Numeric strings retain their wire representation until runtime normalization, so the limit applies before that normalization.

Structs§

AuthPayload
The client’s bearer JWT, carried in the clear (JWTs are only base64url encoded, not encrypted) as SecretString so it auto-redacts from Debug and zeroizes on drop instead of lingering in process memory as a plain String.
AvailableFeatures
room capabilities advertised to a newly connected browser client
ClientBroadcastPayload
DownloadStates
receiver intent for which streams to download from one peer
Envelope
NegotiationUploadEncoding
NegotiationUploadSlot
PeerInfoPayload
PeerLeftPayload
PeerSnapshot
full peer entry sent when a client needs the current room membership view
RecordingActionResult
RecordingOptions
recording modes requested by a user
RecordingState
current room recording state as shown to call participants
RecordingStateUpdate
recording state update emitted to clients and observers
RequestId
ServerBroadcastPayload
SessionDescriptionPayload
SourceDescriptor
SourceEncodingDescriptor
StreamIntentPayload
SubscribePayload
Sparse receiver preferences for the protocol’s audio, camera and screen streams. Unknown fields are ignored and never become retained stream ids. An empty preference update leaves every existing stream preference unchanged.
TrackBinding
UserInfo
presence and call UI state associated with one room participant
UserPermissions
user-level permissions supplied by the Odoo authentication path
WelcomePayload

Enums§

ClientEnvelope
ClientMessage
ClientRequest
ClientResponse
EnvelopeBatchDecodeError
EnvelopeDecodeError
ServerEnvelope
ServerMessage
ServerRequest
ServerResponse
StopCode
business reason attached to a recording stop update
StreamType
stream category exposed to Odoo clients
UploadLayerPolicyRole
UserId
user identity as accepted by the Odoo-facing call contract
VideoLayoutIntent
receiver-side layout role for a video stream
WebSocketCloseCode
websocket close code vocabulary shared by server and browser protocol code

Constants§

MAX_ENVELOPE_BATCH_LEN

Functions§

decode_envelope_batch
Decode a websocket envelope batch while preserving route validation errors and checking a caller-provided batch limit before route conversion.

Type Aliases§

EnvelopeBatch
JsonPayload
opaque compatibility payload carried through legacy broadcast paths