Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::rtcp::header::ByeReasonHeader Class Reference

BYE reason header. More...

#include <headers.h>

Public Member Functions

void reset ()
 Reset to initial state (all zeros). More...
 
size_t text_len () const
 Get text length. More...
 
void set_text_len (const size_t len)
 Set text length. More...
 
const uint8_t * text () const
 Get pointer to text. The text is NOT zero-terminated. More...
 
uint8_t * text ()
 Get pointer to text. The text is NOT zero-terminated. More...
 

Detailed Description

BYE reason header.

Part of BYE packet.

RFC 3550 6.6: "BYE: Goodbye RTCP Packet"

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| length | reason for leaving ...
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

Definition at line 940 of file headers.h.

Member Function Documentation

◆ reset()

void roc::rtcp::header::ByeReasonHeader::reset ( )
inline

Reset to initial state (all zeros).

Definition at line 950 of file headers.h.

◆ set_text_len()

void roc::rtcp::header::ByeReasonHeader::set_text_len ( const size_t  len)
inline

Set text length.

Definition at line 960 of file headers.h.

◆ text() [1/2]

uint8_t* roc::rtcp::header::ByeReasonHeader::text ( )
inline

Get pointer to text. The text is NOT zero-terminated.

Definition at line 973 of file headers.h.

◆ text() [2/2]

const uint8_t* roc::rtcp::header::ByeReasonHeader::text ( ) const
inline

Get pointer to text. The text is NOT zero-terminated.

Definition at line 967 of file headers.h.

◆ text_len()

size_t roc::rtcp::header::ByeReasonHeader::text_len ( ) const
inline

Get text length.

Definition at line 955 of file headers.h.


The documentation for this class was generated from the following file: