Skip to main content

Module message

Module message 

Source
Expand description

Draft-09 control message encoding and decoding.

Wire format is identical to draft-08 except filter_type=1 (NextGroupStart/LatestGroup) is removed from SUBSCRIBE.

StructsΒ§

Announce
ANNOUNCE message (type 0x06).
AnnounceCancel
ANNOUNCE_CANCEL message (type 0x0C).
AnnounceError
ANNOUNCE_ERROR message (type 0x08).
AnnounceOk
ANNOUNCE_OK message (type 0x07).
ClientSetup
CLIENT_SETUP message (type 0x40).
Fetch
FETCH message (type 0x16).
FetchCancel
FETCH_CANCEL message (type 0x17).
FetchError
FETCH_ERROR message (type 0x19).
FetchOk
FETCH_OK message (type 0x18).
GoAway
GOAWAY message (type 0x10).
MaxSubscribeId
MAX_SUBSCRIBE_ID message (type 0x15).
ServerSetup
SERVER_SETUP message (type 0x41).
Subscribe
SUBSCRIBE message (type 0x03).
SubscribeAnnounces
SUBSCRIBE_ANNOUNCES message (type 0x11).
SubscribeAnnouncesError
SUBSCRIBE_ANNOUNCES_ERROR message (type 0x13).
SubscribeAnnouncesOk
SUBSCRIBE_ANNOUNCES_OK message (type 0x12).
SubscribeDone
SUBSCRIBE_DONE message (type 0x0B).
SubscribeError
SUBSCRIBE_ERROR message (type 0x05).
SubscribeOk
SUBSCRIBE_OK message (type 0x04).
SubscribeUpdate
SUBSCRIBE_UPDATE message (type 0x02).
SubscribesBlocked
SUBSCRIBES_BLOCKED message (type 0x1A).
TrackStatus
TRACK_STATUS message (type 0x0E).
TrackStatusRequest
TRACK_STATUS_REQUEST message (type 0x0D).
Unannounce
UNANNOUNCE message (type 0x09).
Unsubscribe
UNSUBSCRIBE message (type 0x0A).
UnsubscribeAnnounces
UNSUBSCRIBE_ANNOUNCES message (type 0x14).

EnumsΒ§

ControlMessage
A decoded MoQT control message (draft-09).
FetchType
Fetch type for FETCH message (draft-09).
MessageType
Control message type IDs (draft-09).

ConstantsΒ§

SETUP_VARINT_PARAMETERS πŸ”’
The setup parameters this draft describes as carrying a single integer.
VERSION_VARINT_PARAMETERS πŸ”’
The version-specific parameters this draft describes as carrying a single integer.

FunctionsΒ§

check_discriminators πŸ”’
Refuse a message whose optional fields disagree with the field that decides whether they are on the wire.
check_group_order πŸ”’
Refuse a Group Order of 0x0 on the messages that forbid it.
check_no_duplicate_parameters πŸ”’
Refuse a parameter list that names the same Parameter Type twice.
check_parameter_lengths πŸ”’
Refuse a parameter whose value is not the shape its type implies.
check_ranges πŸ”’
Refuse a request whose range ends before it starts.
check_track_status πŸ”’
Hold a TRACK_STATUS Status Code and the fields after it to Section 7.24.
decode_parameters πŸ”’
Decode a version-specific parameter list, refusing a repeated type and a value whose length disagrees with its type.
decode_setup_parameters πŸ”’
Decode a setup parameter list.
encode_parameters πŸ”’
Encode a version-specific parameter list, refusing a repeated type and a value whose length disagrees with its type.
encode_setup_parameters πŸ”’
Encode a setup parameter list, under the setup namespace’s implied lengths.
read_group_order_response πŸ”’
Read a Group Order from a message that must name a real order.