RTCPSDESInfo Class Reference

The class RTCPSDESInfo is a container for RTCP SDES information. More...

#include <rtcpsdesinfo.h>

Inherits RTPMemoryObject.

Inherited by RTCPPacketBuilder::RTCPSDESInfoInternal.

List of all members.

Public Member Functions

 RTCPSDESInfo (RTPMemoryManager *mgr=0)
 Constructs an instance, optionally installing a memory manager.
void Clear ()
 Clears all SDES information.
int SetCNAME (const uint8_t *s, size_t l)
 Sets the SDES CNAME item to s with length l.
int SetName (const uint8_t *s, size_t l)
 Sets the SDES name item to s with length l.
int SetEMail (const uint8_t *s, size_t l)
 Sets the SDES e-mail item to s with length l.
int SetPhone (const uint8_t *s, size_t l)
 Sets the SDES phone item to s with length l.
int SetLocation (const uint8_t *s, size_t l)
 Sets the SDES location item to s with length l.
int SetTool (const uint8_t *s, size_t l)
 Sets the SDES tool item to s with length l.
int SetNote (const uint8_t *s, size_t l)
 Sets the SDES note item to s with length l.
int SetPrivateValue (const uint8_t *prefix, size_t prefixlen, const uint8_t *value, size_t valuelen)
 Sets the entry for the prefix string specified by prefix with length prefixlen to contain the value string specified by value with length valuelen (if the maximum allowed number of prefixes was reached, the error code ERR_RTP_SDES_MAXPRIVITEMS is returned.
int DeletePrivatePrefix (const uint8_t *s, size_t len)
 Deletes the entry for the prefix specified by s with length len.
uint8_t * GetCNAME (size_t *len) const
 Returns the SDES CNAME item and stores its length in len.
uint8_t * GetName (size_t *len) const
 Returns the SDES name item and stores its length in len.
uint8_t * GetEMail (size_t *len) const
 Returns the SDES e-mail item and stores its length in len.
uint8_t * GetPhone (size_t *len) const
 Returns the SDES phone item and stores its length in len.
uint8_t * GetLocation (size_t *len) const
 Returns the SDES location item and stores its length in len.
uint8_t * GetTool (size_t *len) const
 Returns the SDES tool item and stores its length in len.
uint8_t * GetNote (size_t *len) const
 Returns the SDES note item and stores its length in len.
void GotoFirstPrivateValue ()
 Starts the iteration over the stored SDES private item prefixes and their associated values.
bool GetNextPrivateValue (uint8_t **prefix, size_t *prefixlen, uint8_t **value, size_t *valuelen)
 Returns SDES priv item information.
bool GetPrivateValue (const uint8_t *prefix, size_t prefixlen, uint8_t **value, size_t *valuelen) const
 Returns SDES priv item information.


Detailed Description


Constructor & Destructor Documentation

RTCPSDESInfo::RTCPSDESInfo ( RTPMemoryManager mgr = 0  )  [inline]


Member Function Documentation

void RTCPSDESInfo::Clear (  ) 

int RTCPSDESInfo::DeletePrivatePrefix ( const uint8_t *  s,
size_t  len 
)

uint8_t* RTCPSDESInfo::GetCNAME ( size_t *  len  )  const [inline]

uint8_t* RTCPSDESInfo::GetEMail ( size_t *  len  )  const [inline]

uint8_t* RTCPSDESInfo::GetLocation ( size_t *  len  )  const [inline]

uint8_t* RTCPSDESInfo::GetName ( size_t *  len  )  const [inline]

bool RTCPSDESInfo::GetNextPrivateValue ( uint8_t **  prefix,
size_t *  prefixlen,
uint8_t **  value,
size_t *  valuelen 
)

If available, returns true and stores the next SDES private item prefix in prefix and its length in prefixlen. The associated value and its length are then stored in value and valuelen. Otherwise, it returns false.

Referenced by RTPSourceData::SDES_GetNextPrivateValue().

uint8_t* RTCPSDESInfo::GetNote ( size_t *  len  )  const [inline]

uint8_t* RTCPSDESInfo::GetPhone ( size_t *  len  )  const [inline]

bool RTCPSDESInfo::GetPrivateValue ( const uint8_t *  prefix,
size_t  prefixlen,
uint8_t **  value,
size_t *  valuelen 
) const

Looks for the entry which corresponds to the SDES private item prefix prefix with length prefixlen. If found, the function returns true and stores the associated value and its length in value and valuelen respectively.

Referenced by RTPSourceData::SDES_GetPrivateValue().

uint8_t* RTCPSDESInfo::GetTool ( size_t *  len  )  const [inline]

void RTCPSDESInfo::GotoFirstPrivateValue (  ) 

int RTCPSDESInfo::SetCNAME ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetEMail ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetLocation ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetName ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetNote ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetPhone ( const uint8_t *  s,
size_t  l 
) [inline]

int RTCPSDESInfo::SetTool ( const uint8_t *  s,
size_t  l 
) [inline]


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

Generated on Sun Jul 26 09:42:11 2009 for jrtplib by  doxygen 1.5.9