roc::rtcp::header::ByeReasonHeader Class Reference

BYE reason header. More...

#include <headers.h>

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

Static Public Attributes
static const size_t	MaxTextLen = 255
	Get maximum allowed reason text length.

Detailed Description

BYE reason header.

Part of BYE 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 882 of file headers.h.

Constructor & Destructor Documentation

ByeReasonHeader()

roc::rtcp::header::ByeReasonHeader::ByeReasonHeader ( )

inline

Definition at line 890 of file headers.h.

Member Function Documentation

reset()

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

inline

Reset to initial state (all zeros).

Definition at line 895 of file headers.h.

set_text_len()

void roc::rtcp::header::ByeReasonHeader::set_text_len ( const size_t  ln )

inline

Set text length.

Definition at line 905 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 918 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 912 of file headers.h.

text_len()

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

inline

Get text length.

Definition at line 900 of file headers.h.

Member Data Documentation

MaxTextLen

const size_t roc::rtcp::header::ByeReasonHeader::MaxTextLen = 255

static

Get maximum allowed reason text length.

Definition at line 888 of file headers.h.

---

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

• roc_rtcp/headers.h