appdataunit(3) [debian man page]
AppDataUnit(3) Library Functions Manual AppDataUnit(3) NAME
AppDataUnit - Interface (envelope) to data received over RTP packets. SYNOPSIS
#include <queuebase.h> Public Member Functions AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src) ~AppDataUnit () AppDataUnit (const AppDataUnit &src) AppDataUnit & operator= (const AppDataUnit &source) Assignment operator. PayloadType getType () const const uint8 *const getData () const Get data as it is received in RTP packets (i.e. size_t getSize () const const SyncSource & getSource () const bool isMarked () const Is this data unit marked?. uint16 getSeqNum () const Get data unit sequence number. uint8 getContributorsCount () const Get the number of contributing sources in the CSRC list. const uint32 * getContributorsID () const Get the array of 32-bit CSRC identifiers. Detailed Description Interface (envelope) to data received over RTP packets. A class of objects representing data transmitted over RTP packets. Tipically, this object will apply to received data. Data blocks received via RTP connections as well as its related objects (source, etc), are accessed through the methods of this class. Author: Federico Montesino Pouzols fedemp@altern.org Examples: audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, rtphello.cpp, and rtplisten.cpp. Constructor &; Destructor Documentation AppDataUnit::AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src) AppDataUnit::~AppDataUnit () [inline] AppDataUnit::AppDataUnit (const AppDataUnit &src) Parameters: src the AppDataUnit object being copied Member Function Documentation uint8 AppDataUnit::getContributorsCount () const [inline] Get the number of contributing sources in the CSRC list. const uint32* AppDataUnit::getContributorsID () const [inline] Get the array of 32-bit CSRC identifiers. Returns: NULL if (getContributorsCount() == 0) const uint8* const AppDataUnit::getData () const [inline] Get data as it is received in RTP packets (i.e. for multi-octet encodings, octets are in network order. Returns: Raw pointer to data block. Examples: audiorx.cpp, ccrtptest.cpp, rtpduphello.cpp, and rtphello.cpp. uint16 AppDataUnit::getSeqNum () const [inline] Get data unit sequence number. size_t AppDataUnit::getSize () const [inline] Returns: length of data in octets Examples: audiorx.cpp, and rtplisten.cpp. const SyncSource& AppDataUnit::getSource () const [inline] Returns: Source that sent this data Examples: rtplisten.cpp. PayloadType AppDataUnit::getType () const [inline] Returns: type of this data Examples: rtplisten.cpp. bool AppDataUnit::isMarked () const [inline] Is this data unit marked?. Returns: true if marked. AppDataUnit& AppDataUnit::operator= (const AppDataUnit &source) Assignment operator. Parameters: source the AppDataUnit object being assigned Returns: the result of the assignment Author Generated automatically by Doxygen for ccRTP from the source code. ccRTP Sat Jun 23 2012 AppDataUnit(3)
Check Out this Related Man Page
ost::MapIndex(3) Library Functions Manual ost::MapIndex(3) NAME
ost::MapIndex - The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. SYNOPSIS
#include <object.h> Public Member Functions MapIndex () Creates an empty map index (pointing to nothing). MapIndex (MapObject *theObject) Creates a map index pointing to a specific map object. MapIndex (const MapIndex &theIndex) Creates a copy of a given map index. void * operator* () const Dereference operator: the pointed object it is returned as void * for easy re-cast. MapIndex & operator= (MapObject *theObject) Assignment operator to avoid implicit cast. MapIndex & operator++ () Prefix increment operator, to be used in loops and such. MapIndex operator++ (int) Postfix increment operator, to be used in loops and such. bool operator== (const MapIndex &theIndex) const Comparison operator, between two MapIndex's. bool operator!= (const MapIndex &theIndex) const bool operator== (const MapObject *theObject) const Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness. bool operator!= (const MapObject *theObject) const Detailed Description The MapIndex allows linear access into a MapTable, that otherwise could have its elements being retrieved only by key. It can be increased, checked and dereferenced like a pointer, by means of suitable operators. Author: Sergio Repetto s.repetto@pentaengineering.it Index object to access MapTable elements Constructor &; Destructor Documentation ost::MapIndex::MapIndex () [inline] Creates an empty map index (pointing to nothing). ost::MapIndex::MapIndex (MapObject *theObject) [inline] Creates a map index pointing to a specific map object. Parameters: the indexed object ost::MapIndex::MapIndex (const MapIndex &theIndex) [inline] Creates a copy of a given map index. Parameters: the source index object Member Function Documentation bool ost::MapIndex::operator!= (const MapIndex &theIndex) const [inline] bool ost::MapIndex::operator!= (const MapObject *theObject) const [inline] void* ost::MapIndex::operator* () const [inline] Dereference operator: the pointed object it is returned as void * for easy re-cast. Returns: pointer to indexed object. MapIndex& ost::MapIndex::operator++ () Prefix increment operator, to be used in loops and such. Returns: the object itself, as changed. MapIndex ost::MapIndex::operator++ (int) [inline] Postfix increment operator, to be used in loops and such. Returns: the object itself, as changed. References operator++(). Referenced by operator++(). MapIndex& ost::MapIndex::operator= (MapObject *theObject) Assignment operator to avoid implicit cast. Returns: the object itself, as changed. bool ost::MapIndex::operator== (const MapIndex &theIndex) const [inline] Comparison operator, between two MapIndex's. Returns: the object itself, as changed. bool ost::MapIndex::operator== (const MapObject *theObject) const [inline] Comparison operator, between the MapIndex and a MapObject, useful to avoid casts for sake of clearness. Returns: the object itself, as changed. Author Generated automatically by Doxygen for GNU CommonC++ from the source code. GNU CommonC++ Sat Jun 23 2012 ost::MapIndex(3)