Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages   Examples  

RTPSource Class Reference

A class of objects representing sources of RTP and RTCP packets. More...

#include <cc++/rtp.h>

List of all members.

Public Methods

bool getHello ()
bool getGoodbye ()
uint32 getID () const
uint32 getRate () const
 Get the transmission rate for this source. More...

void setKitchenSize (microtimeout_t s)
 Specify how much time the incoming packets will be buffered for this source. More...

microtimeout_t getKitchenDuration () const
 Get the required size of the kitchen for this source. More...

uint32 getKitchenSize () const
microtimeout_t getCurrentKitchenDuration ()
 Get the current size of the kitchen (buffer) for this packet as the amount of time covered by the current buffered packet. More...

microtimeout_t getCurrentKitchenSize ()
const char *const getSDESItem (sdes_item_type_t type) const
const char *const getCNAME () const
const char *const getNAME () const
const char *const getEMAIL () const
const char *const getPHONE () const
const char *const getLOC () const
const char *const getTOOL () const
const char *const getNOTE () const
const char *const getPRIV () const
const char *const getH323_CADDR () const
bool isSender () const
 Get if this Source is currently an active sender. More...

bool isValid () const
bool operator== (const RTPSource &rhs) const
bool operator!= (const RTPSource &rhs) const
 RTPSource (uint32 ssrc)
 ~RTPSource ()
 Purges all incoming packets from this source. More...

 RTPSource (const RTPSource &origin)
RTPSource & operator= (const RTPSource &origin)

Friends

class MembershipControl


Detailed Description

A class of objects representing sources of RTP and RTCP packets.

Each source for which any RTP or RTCP packet has been received is represented through an RTPSource object, that provides access to all known data about the source.

Note:
Objects representing sources are dinamically created and destroyed as participants enter, leave or seem to leave the current session.
Author:
Federico Montesino Pouzols <p5087@quintero.fie.us.es>


Constructor & Destructor Documentation

RTPSource::RTPSource uint32   ssrc
 

Parameters:
ssrc   SSRC identifier of the source

RTPSource::~RTPSource  
 

Purges all incoming packets from this source.

RTPSource::RTPSource const RTPSource &   origin
 

Parameters:
origin   the RTPSource object being copied


Member Function Documentation

const char* const RTPSource::getCNAME   const [inline]
 

microtimeout_t RTPSource::getCurrentKitchenDuration   [inline]
 

Get the current size of the kitchen (buffer) for this packet as the amount of time covered by the current buffered packet.

Returns:
amount of time covered by the source reception buffer.

microtimeout_t RTPSource::getCurrentKitchenSize   [inline]
 

const char* const RTPSource::getEMAIL   const [inline]
 

bool RTPSource::getGoodbye  
 

const char* const RTPSource::getH323_CADDR   const [inline]
 

bool RTPSource::getHello  
 

uint32 RTPSource::getID   const [inline]
 

microtimeout_t RTPSource::getKitchenDuration   const [inline]
 

Get the required size of the kitchen for this source.

Returns:
global kitchen size, in microseconds

uint32 RTPSource::getKitchenSize   const [inline]
 

const char* const RTPSource::getLOC   const [inline]
 

const char* const RTPSource::getNAME   const [inline]
 

const char* const RTPSource::getNOTE   const [inline]
 

const char* const RTPSource::getPHONE   const [inline]
 

const char* const RTPSource::getPRIV   const [inline]
 

uint32 RTPSource::getRate   const
 

Get the transmission rate for this source.

Todo:
implement with RTCP checking

const char* const RTPSource::getSDESItem sdes_item_type_t   type const
 

const char* const RTPSource::getTOOL   const [inline]
 

bool RTPSource::isSender   const [inline]
 

Get if this Source is currently an active sender.

bool RTPSource::isValid   const [inline]
 

bool RTPSource::operator!= const RTPSource &   rhs const [inline]
 

RTPSource& RTPSource::operator= const RTPSource &   origin
 

bool RTPSource::operator== const RTPSource &   rhs const [inline]
 

void RTPSource::setKitchenSize microtimeout_t   s [inline]
 

Specify how much time the incoming packets will be buffered for this source.

Note that the size is specified in temporal units, thus the internal queue will usually hold as many packets as necessary to fill the specified amount of time. The default size is the global kitchen size when the source is created.

Parameters:
t   amount of time the reception buffer fills. 0 means there is no buffer/kitchen and, for this source, RTPQueue::getCookedPacket behaves as RTPQueue::getPacket does.


Friends And Related Function Documentation

friend class MembershipControl [friend]
 


The documentation for this class was generated from the following file:
Generated at Wed Dec 5 07:18:09 2001 for ccRTP by doxygen1.2.10 written by Dimitri van Heesch, © 1997-2001