RTP_ControlFrame Class Reference

#include <rtp.h>

List of all members.

Public Types

enum  PayloadTypes {
  e_SenderReport = 200, e_ReceiverReport, e_SourceDescription, e_Goodbye,
  e_ApplDefined
}
enum  DescriptionTypes {
  e_END, e_CNAME, e_NAME, e_EMAIL,
  e_PHONE, e_LOC, e_TOOL, e_NOTE,
  e_PRIV, NumDescriptionTypes
}

Public Member Functions

 RTP_ControlFrame (PINDEX compoundSize=2048)
unsigned GetVersion () const
unsigned GetCount () const
void SetCount (unsigned count)
unsigned GetPayloadType () const
void SetPayloadType (unsigned t)
PINDEX GetPayloadSize () const
void SetPayloadSize (PINDEX sz)
BYTE * GetPayloadPtr () const
BOOL ReadNextCompound ()
BOOL WriteNextCompound ()
PINDEX GetCompoundSize () const
SourceDescriptionAddSourceDescription (DWORD src)
SourceDescription::ItemAddSourceDescriptionItem (SourceDescription &sdes, unsigned type, const PString &data)

Protected Attributes

PINDEX compoundOffset
PINDEX compoundSize

Classes

struct  ReceiverReport
struct  SenderReport
struct  SourceDescription


Detailed Description

An RTP control frame encapsulation.

Definition at line 386 of file rtp.h.


Member Enumeration Documentation

enum RTP_ControlFrame::PayloadTypes

Enumerator:
e_SenderReport 
e_ReceiverReport 
e_SourceDescription 
e_Goodbye 
e_ApplDefined 

Definition at line 398 of file rtp.h.

enum RTP_ControlFrame::DescriptionTypes

Enumerator:
e_END 
e_CNAME 
e_NAME 
e_EMAIL 
e_PHONE 
e_LOC 
e_TOOL 
e_NOTE 
e_PRIV 
NumDescriptionTypes 

Definition at line 442 of file rtp.h.


Member Function Documentation

RTP_ControlFrame::SourceDescription & RTP_ControlFrame::AddSourceDescription ( DWORD  src  ) 

Parameters:
src  SSRC/CSRC identifier

Definition at line 670 of file rtp.cxx.

References e_END, e_SourceDescription, GetCount(), GetPayloadPtr(), GetPayloadSize(), RTP_ControlFrame::SourceDescription::item, SetCount(), SetPayloadSize(), SetPayloadType(), RTP_ControlFrame::SourceDescription::src, and RTP_ControlFrame::SourceDescription::Item::type.

Referenced by RTP_Session::SendReport().

RTP_ControlFrame::SourceDescription::Item & RTP_ControlFrame::AddSourceDescriptionItem ( SourceDescription sdes,
unsigned  type,
const PString &  data 
)

Parameters:
sdes  SDES record to add item to
type  Description type
data  Data for description

Definition at line 687 of file rtp.cxx.

References RTP_ControlFrame::SourceDescription::Item::data, e_END, RTP_ControlFrame::SourceDescription::Item::GetNextItem(), GetPayloadSize(), RTP_ControlFrame::SourceDescription::item, RTP_ControlFrame::SourceDescription::Item::length, SetPayloadSize(), and RTP_ControlFrame::SourceDescription::Item::type.

Referenced by RTP_Session::SendReport().


The documentation for this class was generated from the following files:
Generated on Thu Oct 25 13:46:12 2007 for h323plus by  doxygen 1.5.2