RTPParticipantInfo Class Reference

#include <RTPParticipantInfo.h>

Inheritance diagram for RTPParticipantInfo:

List of all members.

Public Member Functions
	RTPParticipantInfo (u_int32 ssrc=0)
	RTPParticipantInfo (const RTPParticipantInfo &participantInfo)
virtual	~RTPParticipantInfo ()
RTPParticipantInfo &	operator= (const RTPParticipantInfo &participantInfo)
virtual cObject *	dup () const
virtual const char *	className () const
virtual void	processRTPPacket (RTPPacket *packet, simtime_t arrivalTime)
virtual void	processSenderReport (SenderReport *report, simtime_t arrivalTime)
virtual void	processReceptionReport (ReceptionReport *report, simtime_t arrivalTime)
virtual void	processSDESChunk (SDESChunk *sdesChunk, simtime_t arrivalTime)
virtual SDESChunk *	sdesChunk ()
virtual void	addSDESItem (SDESItem *sdesItem)
virtual ReceptionReport *	receptionReport (simtime_t now)
virtual SenderReport *	senderReport (simtime_t now)
virtual void	nextInterval (simtime_t now)
virtual bool	toBeDeleted (simtime_t now)
virtual bool	isSender ()
virtual u_int32	ssrc ()
virtual void	setSSRC (u_int32 ssrc)
virtual IN_Addr	address ()
virtual void	setAddress (IN_Addr address)
virtual IN_Port	rtpPort ()
virtual void	setRTPPort (IN_Port rtpPort)
virtual IN_Port	rtcpPort ()
virtual void	setRTCPPort (IN_Port rtpPort)
Static Public Member Functions
static char *	ssrcToName (u_int32 ssrc)
Protected Member Functions
virtual void	addSDESItem (SDESItem::SDES_ITEM_TYPE type, const char *content)
Protected Attributes
SDESChunk *	_sdesChunk
IN_Addr	_address
IN_Port	_rtpPort
IN_Port	_rtcpPort
int	_silentIntervals

---

Detailed Description

This class is a super class for classes intended for storing information about rtp end systems. It has two subclasses: RTPReceiverInformation which is used for storing information about other system participating in an rtp session. RTPSenderInformation is used by an rtp endsystem for storing information about itself.

See also:

RTPReceiverInformation

RTPSenderInformation

---

Constructor & Destructor Documentation

RTPParticipantInfo::RTPParticipantInfo (  u_int32  ssrc = 0  )

Default constructor.

RTPParticipantInfo::RTPParticipantInfo (  const RTPParticipantInfo &  participantInfo  )

Copy constructor.

RTPParticipantInfo::~RTPParticipantInfo (   )  [virtual]

Destructor.

---

Member Function Documentation

IN_Addr RTPParticipantInfo::address (   )  [virtual]

Returns the ip address of the rtp endsystem.

void RTPParticipantInfo::addSDESItem (  SDESItem::SDES_ITEM_TYPE  type, const char *  content )  [protected, virtual]

Creates a new SDESItem and adds it to the SDESChunk stored in this RTPParticipantInfo.

void RTPParticipantInfo::addSDESItem (  SDESItem *  sdesItem  )  [virtual]

Adds this sdes item to the sdes chunk of this participant.

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

Returns the class name "RTPParticipantInfo". Reimplemented in RTPReceiverInfo, and RTPSenderInfo.

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

Duplicates this RTPParticipantInfo by calling the copy constructor. Reimplemented in RTPReceiverInfo, and RTPSenderInfo.

bool RTPParticipantInfo::isSender (   )  [virtual]

Returns true if this endsystem has sent at least one rtp data packet during the last two rtcp intervals (including the current one).

void RTPParticipantInfo::nextInterval (  simtime_t  now  )  [virtual]

This method should be called by the rtcp module which uses this class for storing information every time an rtcp packet is sent. Some behaviour of rtp and rtcp (and this class) depend on how many rtcp intervals have passed, for example an rtp end system is marked as inactive if there haven't been received packets from it for a certain number of rtpc intervals. Call senderReport() and receptionReport() before calling this method. See also: senderReport() receptionReport() Reimplemented in RTPReceiverInfo.

RTPParticipantInfo & RTPParticipantInfo::operator= (  const RTPParticipantInfo &  participantInfo  )

Assignment operator.

void RTPParticipantInfo::processReceptionReport (  ReceptionReport *  report, simtime_t  arrivalTime )  [virtual]

This method extracts information of the given ReceptionReport. Reimplemented in RTPSenderInfo.

void RTPParticipantInfo::processRTPPacket (  RTPPacket *  packet, simtime_t  arrivalTime )  [virtual]

This method should be extended by a subclass for extracting information about the originating endsystem of an rtp packet. This method sets _silentInterval to 0 so that the sender of this rtp packet is regarded as an active sender. Reimplemented in RTPReceiverInfo, and RTPSenderInfo.

void RTPParticipantInfo::processSDESChunk (  SDESChunk *  sdesChunk, simtime_t  arrivalTime )  [virtual]

This method extracts sdes information of the given sdes chunk.and stores it. Reimplemented in RTPReceiverInfo.

void RTPParticipantInfo::processSenderReport (  SenderReport *  report, simtime_t  arrivalTime )  [virtual]

This method extracts information about an rtp endsystem as provided by the given SenderReport. Reimplemented in RTPReceiverInfo.

ReceptionReport * RTPParticipantInfo::receptionReport (  simtime_t  now  )  [virtual]

This method is intended to be overwritten by subclasses. It should return a receiver report if there have been received rtp packets from that endsystem and NULL otherwise. The implementation for this class always returns NULL. Reimplemented in RTPReceiverInfo.

IN_Port RTPParticipantInfo::rtcpPort (   )  [virtual]

Returns the port used by this endsystem for transmitting rtcp packets.

IN_Port RTPParticipantInfo::rtpPort (   )  [virtual]

Returns the port used by this endsystem for transmitting rtp packets.

SDESChunk * RTPParticipantInfo::sdesChunk (   )  [virtual]

Returns a copy of the sdes chunk used for storing source description items about this system.

SenderReport * RTPParticipantInfo::senderReport (  simtime_t  now  )  [virtual]

This method is intended to be overwritten by subclasses which are used for storing information about itself. It should return a sender report if there have been sent rtp packets recently or NULL otherwise. The implementation for this class always returns NULL. Reimplemented in RTPSenderInfo.

void RTPParticipantInfo::setAddress (  IN_Addr  address  )  [virtual]

Sets the ip address of the rtp endsystem.

void RTPParticipantInfo::setRTCPPort (  IN_Port  rtpPort  )  [virtual]

Sets the port used by the endsystem for transmitting rtcp packets.

void RTPParticipantInfo::setRTPPort (  IN_Port  rtpPort  )  [virtual]

Sets the port used by the endsystem for transmitting rtp packets.

void RTPParticipantInfo::setSSRC (  u_int32  ssrc  )  [virtual]

Sets the ssrc identifier.

u_int32 RTPParticipantInfo::ssrc (   )  [virtual]

Returns the ssrc identifier of the rtp endsystem.

char * RTPParticipantInfo::ssrcToName (  u_int32  ssrc  )  [static]

This method returns the given 32 bit ssrc identifier as an 8 character hexadecimal number which is used as name of an RTPParticipantInfo object.

bool RTPParticipantInfo::toBeDeleted (  simtime_t  now  )  [virtual]

Returns true if the end system does no longer participate in the rtp session. The implementation in this class always returns false. Reimplemented in RTPReceiverInfo, and RTPSenderInfo.

---

Member Data Documentation

IN_Addr RTPParticipantInfo::_address [protected]

Used for storing the ip address of this endsystem.

IN_Port RTPParticipantInfo::_rtcpPort [protected]

Used for storing the port for rtcp by this endsystem.

IN_Port RTPParticipantInfo::_rtpPort [protected]

Used for storing the port for rtp by this endsystem.

SDESChunk* RTPParticipantInfo::_sdesChunk [protected]

Used for storing sdes information about this rtp endsystem. The ssrc identifier is also stored here.

int RTPParticipantInfo::_silentIntervals [protected]

Stores the number of rtcp intervals (including the current one) during which this rtp endsystem hasn't sent any rtp data packets. When an rtp data packet is received it is reset to 0.

---

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

• RTPParticipantInfo.h
• RTPParticipantInfo.cc

---