RTPInterfacePacket Class Reference

#include <RTPInterfacePacket.h>

List of all members.

Public Types
enum	RTP_IFP_TYPE {   RTP_IFP_UNDEF, RTP_IFP_ENTER_SESSION, RTP_IFP_SESSION_ENTERED, RTP_IFP_CREATE_SENDER_MODULE,   RTP_IFP_SENDER_MODULE_CREATED, RTP_IFP_DELETE_SENDER_MODULE, RTP_IFP_SENDER_MODULE_DELETED, RTP_IFP_SENDER_CONTROL,   RTP_IFP_SENDER_STATUS, RTP_IFP_LEAVE_SESSION, RTP_IFP_SESSION_LEFT }
Public Member Functions
	RTPInterfacePacket (const char *name=NULL)
	RTPInterfacePacket (const RTPInterfacePacket &rifp)
virtual	~RTPInterfacePacket ()
RTPInterfacePacket &	operator= (const RTPInterfacePacket &rifp)
virtual cObject *	dup () const
virtual const char *	className () const
virtual void	info (char *buf)
virtual void	writeContents (ostream &os)
virtual void	enterSession (const char *commonName, const char *profileName, int bandwidth, IN_Addr destinationAddress, IN_Port port)
virtual void	sessionEntered (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	senderModuleControl (u_int32 ssrc, RTPSenderControlMessage *msg)
virtual void	senderModuleStatus (u_int32 ssrc, RTPSenderStatusMessage *msg)
virtual void	leaveSession ()
virtual void	sessionLeft ()
virtual RTP_IFP_TYPE	type ()
virtual const char *	commonName ()
virtual const char *	profileName ()
virtual int	bandwidth ()
virtual IN_Addr	destinationAddress ()
virtual IN_Port	port ()
virtual u_int32	ssrc ()
virtual int	payloadType ()
virtual const char *	fileName ()

---

Detailed Description

The class RTPInterfacePacket is used for communication between an RTPApplication and an RTPLayer module. Its offers functionality for starting and stopping of an rtp session, transmission of files and feedback about the success of the operations.

---

Member Enumeration Documentation

enum RTPInterfacePacket::RTP_IFP_TYPE

An enumeration to distinguish the different functions of the RTPInterfacePacket. Enumeration values: RTP_IFP_UNDEF  RTP_IFP_ENTER_SESSION  RTP_IFP_SESSION_ENTERED  RTP_IFP_CREATE_SENDER_MODULE  RTP_IFP_SENDER_MODULE_CREATED  RTP_IFP_DELETE_SENDER_MODULE  RTP_IFP_SENDER_MODULE_DELETED  RTP_IFP_SENDER_CONTROL  RTP_IFP_SENDER_STATUS  RTP_IFP_LEAVE_SESSION  RTP_IFP_SESSION_LEFT

---

Constructor & Destructor Documentation

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

Default constructor.

RTPInterfacePacket::RTPInterfacePacket (  const RTPInterfacePacket &  rifp  )

Copy constructor.

RTPInterfacePacket::~RTPInterfacePacket (   )  [virtual]

Destructor.

---

Member Function Documentation

int RTPInterfacePacket::bandwidth (   )  [virtual]

Returns the bandidth stored in this RTPInterfacePacket.

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

Returns the class name "RTPInterfacePacket".

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

Returns the CNAME stored in this RTPInterfacePacket.

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

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

IN_Addr RTPInterfacePacket::destinationAddress (   )  [virtual]

Returns the address stored in this RTPInterfacePacket.

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

Duplicates the RTPInterfacePacket by calling the copy constructor.

void RTPInterfacePacket::enterSession (  const char *  commonName, const char *  profileName, int  bandwidth, IN_Addr  destinationAddress, IN_Port  port )  [virtual]

Called by the rtp application to make the rtp layer enter an rtp session with the given parameters.

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

Returns the file name stored in this RTPInterfacePacket.

void RTPInterfacePacket::info (  char *  buf  )  [virtual]

Writes a one line info about this RTPInterfacePacket into the given string.

void RTPInterfacePacket::leaveSession (   )  [virtual]

Called by the application to order the rtp layer to stop participating in this rtp session.

RTPInterfacePacket & RTPInterfacePacket::operator= (  const RTPInterfacePacket &  rifp  )

Assignment operator.

int RTPInterfacePacket::payloadType (   )  [virtual]

Returns the payload type stored in this RTPInterfacePacket.

IN_Port RTPInterfacePacket::port (   )  [virtual]

Returns the port stored in this RTPInterfacePacket.

const char * RTPInterfacePacket::profileName (   )  [virtual]

Returns the profile name stored in this RTPInterfacePacket.

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

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

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

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

void RTPInterfacePacket::sessionEntered (  u_int32  ssrc  )  [virtual]

Called by the rtp module to inform the application that the rtp session has been entered.

void RTPInterfacePacket::sessionLeft (   )  [virtual]

Called by the rtp module to inform the application that this end system stop participating in this rtp session.

u_int32 RTPInterfacePacket::ssrc (   )  [virtual]

Returns the ssrc identifier stored in this RTPInterfacePacket.

RTPInterfacePacket::RTP_IFP_TYPE RTPInterfacePacket::type (   )  [virtual]

Returns the type of this RTPInterfacePacket.

void RTPInterfacePacket::writeContents (  ostream &  os  )  [virtual]

Writes a longer info about this RTPInterfacePacket into the given stream.

---

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

• RTPInterfacePacket.h
• RTPInterfacePacket.cc

---