Enum ProtocolControl 

#[non_exhaustive]
pub enum ProtocolControl {
    SetChunkSize(u32),
    Abort {
        chunk_stream_id: u32,
    },
    Acknowledgement(u32),
    WindowAckSize(u32),
    SetPeerBandwidth {
        ack_window_size: u32,
        limit_type: LimitType,
    },
}

A Chunk-Stream-layer protocol control message (§4, spec §5.4): message type ids 1, 2, 3, 5, 6. MUST use message stream id 0 and chunk stream id 2 (CONTROL_MESSAGE_STREAM_ID / CONTROL_CHUNK_STREAM_ID); effective immediately on receipt.

#[non_exhaustive]: §4’s protocol control catalogue is closed today, but this mirrors UserControl/crate::amf0::Amf0Value so a future addition never breaks an existing match.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

SetChunkSize(u32)

Set Chunk Size (§5.4.1): the new maximum chunk size (1..=0x7FFF_FFFF).

Abort

Abort Message (§5.4.2): discard any partially-received message on this chunk stream id.

Fields

chunk_stream_id: u32

The chunk stream id whose in-progress message should be discarded.

Acknowledgement(u32)

Acknowledgement (§5.4.3): total bytes received so far.

WindowAckSize(u32)

Window Acknowledgement Size (§5.4.4): the sender’s advertised window size.

SetPeerBandwidth

Set Peer Bandwidth (§5.4.5): limit the peer’s output bandwidth.

Fields

ack_window_size: u32

The acknowledgement window size to limit the peer to.

limit_type: LimitType

How strictly the peer should observe the limit.

Implementations

impl ProtocolControl

pub fn name(&self) -> &'static str

The spec token for this protocol control message.

pub fn message_type_id(&self) -> u8

This variant’s message type id (§6/§7.1).

pub fn from_message(message: &Message) -> Result<Option<Self>, RtmpError>

Interpret an already-reassembled Message as a protocol control message, dispatching on message.message_type_id.

Returns Ok(None) if message.message_type_id is not one of the protocol control ids (1, 2, 3, 5, 6) — the caller should then dispatch it elsewhere (user control, audio/video, command, …).

Errors

RtmpError::BufferTooShort if the payload is shorter than the message type requires; RtmpError::Malformed if a field violates its wire constraint (reserved bit set, out-of-range limit type).

pub fn from_payload( message_type_id: u8, payload: &[u8], ) -> Result<Option<Self>, RtmpError>

Parse a protocol control payload given its message type id. Not a Parse impl: unlike every other wire type in this crate, a protocol control payload alone is ambiguous (e.g. a bare 4-byte payload is SetChunkSize, Abort, Acknowledgement, or WindowAckSize depending on the message type id carried alongside it in the Message header) — the type id is required context.

Errors

See ProtocolControl::from_message.

pub fn to_message(&self) -> Message

Wrap this protocol control message in a Message ready to hand to crate::chunk::ChunkWriter — chunk stream id CONTROL_CHUNK_STREAM_ID, message stream id CONTROL_MESSAGE_STREAM_ID, timestamp 0 (protocol control messages take effect immediately; timestamps are not meaningful).

Trait Implementations

impl Clone for ProtocolControl

fn clone(&self) -> ProtocolControl

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for ProtocolControl

impl Debug for ProtocolControl

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

Formats the value using the given formatter.

impl Display for ProtocolControl

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

Formats the value using the given formatter.

impl Eq for ProtocolControl

impl PartialEq for ProtocolControl

fn eq(&self, other: &ProtocolControl) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ProtocolControl

type Error = RtmpError

The error type this implementer returns (usually the same as the corresponding Parse impl, but need not be).

fn serialized_len(&self) -> usize

Number of bytes serialize_into will write.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize, RtmpError>

Write the serialised form into buf. Returns the number of bytes written (always equal to serialized_len()).

fn to_bytes(&self) -> Vec<u8>

where Self::Error: Debug,

Convenience: allocate a Vec and serialise into it.

impl StructuralPartialEq for ProtocolControl