Struct ControlPacket

pub struct ControlPacket {
    pub timestamp: TimeStamp,
    pub dest_sockid: SocketId,
    pub control_type: ControlTypes,
}

A UDP packet carrying control information

 0                   1                   2                   3
 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |1|             Type            |            Reserved           |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |     |                    Additional Info                      |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                            Time Stamp                         |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                    Destination Socket ID                      |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 |                                                               |
 ~                 Control Information Field                     ~
 |                                                               |
 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

(from https://tools.ietf.org/html/draft-gg-udt-03#page-5)

Fields

timestamp: TimeStamp

The timestamp, relative to the socket start time (wrapping every 2^32 microseconds)

dest_sockid: SocketId

The dest socket ID, used for multiplexing

control_type: ControlTypes

The extra data

Implementations

impl ControlPacket

pub const HEADER_SIZE: usize = 44usize

impl ControlPacket

pub fn parse( buf: &mut impl Buf, is_ipv6: bool, ) -> Result<ControlPacket, PacketParseError>

pub fn serialize<T: BufMut>(&self, into: &mut T)

pub fn handshake(&self) -> Option<&HandshakeControlInfo>

pub fn wire_size(&self) -> usize

Trait Implementations

impl Clone for ControlPacket

fn clone(&self) -> ControlPacket

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ControlPacket

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

Formats the value using the given formatter.

impl From<ControlPacket> for Packet

fn from(cp: ControlPacket) -> Self

Converts to this type from the input type.

impl PartialEq for ControlPacket

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ControlPacket

impl StructuralPartialEq for ControlPacket