Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::rtcp::SdesTraverser::Iterator Class Reference

Packet iterator. More...

#include <sdes_traverser.h>

Public Types

enum  State { BEGIN , CHUNK , ITEM , END }
 Iterator state. More...
 

Public Member Functions

State next ()
 Advance iterator. More...
 
bool error () const
 Check if there were any parsing errors. More...
 
SdesChunk get_chunk () const
 Get SDES chunk. More...
 
SdesItem get_item () const
 Get SDES item. Item is valid only until next() call. More...
 

Friends

class SdesTraverser
 

Detailed Description

Packet iterator.

Definition at line 28 of file sdes_traverser.h.

Member Enumeration Documentation

◆ State

Iterator state.

Enumerator
BEGIN 

Iterator created.

CHUNK 

SDES chunk.

ITEM 

SDES item.

END 

Parsed whole packet.

Definition at line 31 of file sdes_traverser.h.

Member Function Documentation

◆ error()

bool roc::rtcp::SdesTraverser::Iterator::error ( ) const

Check if there were any parsing errors.

◆ get_chunk()

SdesChunk roc::rtcp::SdesTraverser::Iterator::get_chunk ( ) const

Get SDES chunk.

Precondition
Can be used if next() returned CHUNK.

◆ get_item()

SdesItem roc::rtcp::SdesTraverser::Iterator::get_item ( ) const

Get SDES item. Item is valid only until next() call.

Precondition
Can be used if next() returned ITEM.

◆ next()

State roc::rtcp::SdesTraverser::Iterator::next ( )

Advance iterator.


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