RTPInnerPacket Class Reference

#include <RTPInnerPacket.h>

List of all members.

Public Types
enum	RTP_INP_TYPE {   RTP_INP_UNDEF, RTP_INP_INITIALIZE_PROFILE, RTP_INP_PROFILE_INITIALIZED, RTP_INP_INITIALIZE_RTCP,   RTP_INP_RTCP_INITIALIZED, RTP_INP_CREATE_SENDER_MODULE, RTP_INP_SENDER_MODULE_CREATED, RTP_INP_DELETE_SENDER_MODULE,   RTP_INP_SENDER_MODULE_DELETED, RTP_INP_INITIALIZE_SENDER_MODULE, RTP_INP_SENDER_MODULE_INITIALIZED, RTP_INP_SENDER_MODULE_CONTROL,   RTP_INP_SENDER_MODULE_STATUS, RTP_INP_LEAVE_SESSION, RTP_INP_SESSION_LEFT, RTP_INP_DATA_OUT,   RTP_INP_DATA_IN }
Public Member Functions
	RTPInnerPacket (const char *name=NULL)
	RTPInnerPacket (const RTPInnerPacket &rinp)
virtual	~RTPInnerPacket ()
RTPInnerPacket &	operator= (const RTPInnerPacket &rinp)
virtual cObject *	dup () const
virtual const char *	className () const
virtual void	info (char *buf) const
virtual void	writeContents (ostream &os) const
virtual void	initializeProfile (int mtu)
virtual void	profileInitialized (int rtcpPercentage, IN_Port port)
virtual void	initializeRTCP (const char *commonName, int mtu, int bandwidth, int rtcpPercentage, IN_Addr address, IN_Port port)
virtual void	rtcpInitialized (u_int32 ssrc)
virtual void	createSenderModule (u_int32 ssrc, int payloadType, const char *fileName)
virtual void	senderModuleCreated (u_int32 ssrc)
virtual void	deleteSenderModule (u_int32 ssrc)
virtual void	senderModuleDeleted (u_int32 ssrc)
virtual void	initializeSenderModule (u_int32 ssrc, const char *fileName, int mtu)
virtual void	senderModuleInitialized (u_int32 ssrc, int payloadType, int clockRate, int timeStampBase, int sequenceNumberBase)
virtual void	senderModuleControl (u_int32 ssrc, RTPSenderControlMessage *msg)
virtual void	senderModuleStatus (u_int32 ssrc, RTPSenderStatusMessage *msg)
virtual void	leaveSession ()
virtual void	sessionLeft ()
virtual void	dataOut (RTPPacket *packet)
virtual void	dataIn (RTPPacket *packet, IN_Addr address, IN_Port port)
virtual RTP_INP_TYPE	type ()
virtual const char *	commonName ()
virtual int	mtu ()
virtual int	bandwidth ()
virtual int	rtcpPercentage ()
virtual IN_Addr	address ()
virtual IN_Port	port ()
virtual u_int32	ssrc ()
virtual int	payloadType ()
virtual const char *	fileName ()
virtual int	clockRate ()
virtual int	timeStampBase ()
virtual int	sequenceNumberBase ()

---

Detailed Description

This class is used for communication between submodules of the rtp layer module.

---

Member Enumeration Documentation

enum RTPInnerPacket::RTP_INP_TYPE

This enumeration is a list of all possibly types of an RTPInnerPacket. Enumeration values: RTP_INP_UNDEF  RTP_INP_INITIALIZE_PROFILE  RTP_INP_PROFILE_INITIALIZED  RTP_INP_INITIALIZE_RTCP  RTP_INP_RTCP_INITIALIZED  RTP_INP_CREATE_SENDER_MODULE  RTP_INP_SENDER_MODULE_CREATED  RTP_INP_DELETE_SENDER_MODULE  RTP_INP_SENDER_MODULE_DELETED  RTP_INP_INITIALIZE_SENDER_MODULE  RTP_INP_SENDER_MODULE_INITIALIZED  RTP_INP_SENDER_MODULE_CONTROL  RTP_INP_SENDER_MODULE_STATUS  RTP_INP_LEAVE_SESSION  RTP_INP_SESSION_LEFT  RTP_INP_DATA_OUT  RTP_INP_DATA_IN

---

Constructor & Destructor Documentation

RTPInnerPacket::RTPInnerPacket (  const char *  name = NULL  )

Default constructor

RTPInnerPacket::RTPInnerPacket (  const RTPInnerPacket &  rinp  )

Copy constructor.

RTPInnerPacket::~RTPInnerPacket (   )  [virtual]

Destructor.

---

Member Function Documentation

IN_Addr RTPInnerPacket::address (   )  [virtual]

Returns the address stored in this RTPInnerPacket.

int RTPInnerPacket::bandwidth (   )  [virtual]

Returns the available bandwitdth as stored in this RTPInnerPacket.

const char * RTPInnerPacket::className (   )  const [virtual]

Returns the class name "RTPInnerPacket".

int RTPInnerPacket::clockRate (   )  [virtual]

Returns the rtp clock rate stored in this RTPInnerPacket.

const char * RTPInnerPacket::commonName (   )  [virtual]

Returns the CNAME stored in this RTPInnerPacket.

void RTPInnerPacket::createSenderModule (  u_int32  ssrc, int  payloadType, const char *  fileName )  [virtual]

void RTPInnerPacket::dataIn (  RTPPacket *  packet, IN_Addr  address, IN_Port  port )  [virtual]

Capsultes the incoming RTPPacket into this RTPInnerPacket to transport it within the rtp layer.

void RTPInnerPacket::dataOut (  RTPPacket *  packet  )  [virtual]

Capsulates the outgoing RTPPacket into this RTPInnerPacket to transport it within the rtp layer.

void RTPInnerPacket::deleteSenderModule (  u_int32  ssrc  )  [virtual]

cObject * RTPInnerPacket::dup (   )  const [virtual]

Duplicates the RTPInnerPacket by calling the copy constructor.

const char * RTPInnerPacket::fileName (   )  [virtual]

Returns the file name stored in this RTPInnerPacket.

void RTPInnerPacket::info (  char *  buf  )  const [virtual]

Writes a short info about this RTPInnerPacket into the given string.

void RTPInnerPacket::initializeProfile (  int  mtu  )  [virtual]

Called by the rtp module after creating the profile module. It informes the profile about the maximum size an rtp packet can have.

void RTPInnerPacket::initializeRTCP (  const char *  commonName, int  mtu, int  bandwidth, int  rtcpPercentage, IN_Addr  address, IN_Port  port )  [virtual]

Called by the rtp module to inform the rtcp module about mandatory information for starting the rtp session.

void RTPInnerPacket::initializeSenderModule (  u_int32  ssrc, const char *  fileName, int  mtu )  [virtual]

void RTPInnerPacket::leaveSession (   )  [virtual]

Called by the rtp module to inform the rtcp module that the session should be left.

int RTPInnerPacket::mtu (   )  [virtual]

Returns the maximum transmission unit stored in this RTPInnerPacket.

RTPInnerPacket & RTPInnerPacket::operator= (  const RTPInnerPacket &  rinp  )

Assignment operator.

int RTPInnerPacket::payloadType (   )  [virtual]

Returns the payload type stored in this RTPInnerPacket.

IN_Port RTPInnerPacket::port (   )  [virtual]

Returns the port stored in this RTPInnerPacket.

void RTPInnerPacket::profileInitialized (  int  rtcpPercentage, IN_Port  port )  [virtual]

Called by the profile module after it has received the initializeProfile() message. It informs the rtp module about the percentage of the available bandwidth to be used by rtcp and the preferred port for this profile.

void RTPInnerPacket::rtcpInitialized (  u_int32  ssrc  )  [virtual]

Called by the rtcp module after it has waited for half an rtcp interval for incoming messages from other session participants. It informs the rtp module which later informs the rtp application about the ssrc identifier this rtp endsystem uses.

int RTPInnerPacket::rtcpPercentage (   )  [virtual]

Returns the percentage of bandwidth for rtcp as stored in this RTPInnerPacket.

void RTPInnerPacket::senderModuleControl (  u_int32  ssrc, RTPSenderControlMessage *  msg )  [virtual]

void RTPInnerPacket::senderModuleCreated (  u_int32  ssrc  )  [virtual]

void RTPInnerPacket::senderModuleDeleted (  u_int32  ssrc  )  [virtual]

void RTPInnerPacket::senderModuleInitialized (  u_int32  ssrc, int  payloadType, int  clockRate, int  timeStampBase, int  sequenceNumberBase )  [virtual]

void RTPInnerPacket::senderModuleStatus (  u_int32  ssrc, RTPSenderStatusMessage *  msg )  [virtual]

int RTPInnerPacket::sequenceNumberBase (   )  [virtual]

Returns the rtp sequence number base stored in this RTPInnerPacket.

void RTPInnerPacket::sessionLeft (   )  [virtual]

Called by the rtcp module when the rtcp bye packet has been sent to the network.

u_int32 RTPInnerPacket::ssrc (   )  [virtual]

Returns the ssrc identifier stored in this RTPInnerPacket.

int RTPInnerPacket::timeStampBase (   )  [virtual]

Returns the rtp time stamp base stored in this RTPInnerPacket.

RTPInnerPacket::RTP_INP_TYPE RTPInnerPacket::type (   )  [virtual]

Returns the type of this RTPInnerPacket.

void RTPInnerPacket::writeContents (  ostream &  os  )  const [virtual]

Writes a longer info about this RTPInnerPacket into the given output stream.

---

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

• RTPInnerPacket.h
• RTPInnerPacket.cc

---