ost::AppDataUnit Class Reference
[Base classes for RTP queues.Base classes for RTP queues.]

Interface (envelope) to data received over RTP packets. More...

#include <queuebase.h>

List of all members.

Public Member Functions

 AppDataUnit (const IncomingRTPPkt &packet, const SyncSource &src)
 ~AppDataUnit ()
 AppDataUnit (const AppDataUnit &src)
AppDataUnitoperator= (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 SyncSourcegetSource () 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 uint32getContributorsID () 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>


Constructor & Destructor Documentation

ost::AppDataUnit::AppDataUnit const IncomingRTPPkt packet,
const SyncSource src
 

ost::AppDataUnit::~AppDataUnit  )  [inline]
 

ost::AppDataUnit::AppDataUnit const AppDataUnit src  ) 
 

Parameters:
src the AppDataUnit object being copied


Member Function Documentation

uint8 ost::AppDataUnit::getContributorsCount  )  const [inline]
 

Get the number of contributing sources in the CSRC list.

const uint32* ost::AppDataUnit::getContributorsID  )  const [inline]
 

Get the array of 32-bit CSRC identifiers.

Returns:
NULL if (getContributorsCount() == 0)

const uint8* const ost::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.

uint16 ost::AppDataUnit::getSeqNum  )  const [inline]
 

Get data unit sequence number.

size_t ost::AppDataUnit::getSize void   )  const [inline]
 

Returns:
length of data in octets

const SyncSource& ost::AppDataUnit::getSource  )  const [inline]
 

Returns:
Source that sent this data

PayloadType ost::AppDataUnit::getType  )  const [inline]
 

Returns:
type of this data

bool ost::AppDataUnit::isMarked  )  const [inline]
 

Is this data unit marked?.

Returns:
true if marked.

AppDataUnit& ost::AppDataUnit::operator= const AppDataUnit source  ) 
 

Assignment operator.

Parameters:
source the AppDataUnit object being assigned
Returns:
the result of the assignment


The documentation for this class was generated from the following file:
Generated on Thu Apr 6 09:03:06 2006 for Bayonne Framework by  doxygen 1.4.6