The class RTPSenderInfo is used by an RTP end system for storing information about itself. More...

#include <RTPSenderInfo.h>

Inheritance diagram for inet::rtp::RTPSenderInfo:

Public Member Functions
	RTPSenderInfo (uint32 ssrc=0)
	Default constructor. More...

	RTPSenderInfo (const RTPSenderInfo &senderInfo)
	Copy constructor. More...

virtual	~RTPSenderInfo ()
	Destructor. More...

RTPSenderInfo &	operator= (const RTPSenderInfo &senderInfo)
	Assignment operator. More...

virtual RTPSenderInfo *	dup () const override
	Duplicates this RTPSenderInfo by calling the copy constructor. More...

virtual void	processRTPPacket (RTPPacket *packet, int id, simtime_t arrivalTime) override
	Stores information about this outgoing RTPPacket. More...

virtual void	processReceptionReport (ReceptionReport *report, simtime_t arrivalTime)
	Processes an incoming ReceptionReport for this sender. More...

virtual SenderReport *	senderReport (simtime_t now) override
	Returns a SenderReport for this rtp endsystem. More...

virtual void	setStartTime (simtime_t startTime)
	Sets the time (simTime) when this endsystem has started sending rtp packets. More...

virtual void	setClockRate (int clockRate)
	Sets the clock rate (in ticks per second) this sender increases the rtp time stamp. More...

virtual void	setTimeStampBase (uint32 timeStampBase)
	Sets the initial rtp time stamp. More...

virtual void	setSequenceNumberBase (uint16 sequenceNumberBase)
	Sets the initial sequence number. More...

Public Member Functions inherited from inet::rtp::RTPParticipantInfo
	RTPParticipantInfo (uint32 ssrc=0)
	Default constructor. More...

	RTPParticipantInfo (const RTPParticipantInfo &participantInfo)
	Copy constructor. More...

virtual	~RTPParticipantInfo ()
	Destructor. More...

RTPParticipantInfo &	operator= (const RTPParticipantInfo &participantInfo)
	Assignment operator. More...

virtual void	processSenderReport (SenderReport &report, simtime_t arrivalTime)
	This method extracts information about an RTP endsystem as provided by the given SenderReport. More...

virtual void	processReceptionReport (ReceptionReport &report, simtime_t arrivalTime)
	This method extracts information of the given ReceptionReport. More...

virtual void	processSDESChunk (SDESChunk *sdesChunk, simtime_t arrivalTime)
	This method extracts sdes information of the given sdes chunk.and stores it. More...

virtual SDESChunk *	getSDESChunk () const
	Returns a copy of the sdes chunk used for storing source description items about this system. More...

virtual void	addSDESItem (SDESItem *sdesItem)
	Adds this sdes item to the sdes chunk of this participant. More...

virtual ReceptionReport *	receptionReport (simtime_t now)
	This method is intended to be overwritten by subclasses. More...

virtual void	nextInterval (simtime_t now)
	This method should be called by the rtcp module which uses this class for storing information every time an rtcp packet is sent. More...

virtual bool	toBeDeleted (simtime_t now)
	Returns true if the end system does no longer participate in the RTP session. More...

virtual bool	isSender () const
	Returns true if this endsystem has sent at least one RTP data packet during the last two rtcp intervals (including the current one). More...

virtual uint32	getSsrc () const override
	Returns the ssrc identifier of the RTP endsystem. More...

virtual void	setSsrc (uint32 ssrc) override
	Sets the ssrc identifier. More...

virtual void	addSDESItem (SDESItem::SDES_ITEM_TYPE type, const char *content)
	Creates a new SDESItem and adds it to the SDESChunk stored in this RTPParticipantInfo. More...

virtual void	parsimPack (cCommBuffer *b) const override

virtual void	parsimUnpack (cCommBuffer *b) override

Public Member Functions inherited from inet::rtp::RTPParticipantInfo_Base
virtual	~RTPParticipantInfo_Base ()

virtual void	parsimPack (omnetpp::cCommBuffer *b) const override

virtual void	parsimUnpack (omnetpp::cCommBuffer *b) override

virtual IPv4Address &	getAddress ()

virtual const IPv4Address &	getAddress () const

virtual void	setAddress (const IPv4Address &address)

virtual int	getRTPPort () const

virtual void	setRTPPort (int RTPPort)

virtual int	getRTCPPort () const

virtual void	setRTCPPort (int RTCPPort)

Protected Attributes
simtime_t	_startTime
	The time when the transmission was started. More...

int	_clockRate
	The clock rate this sender increases the rtp time stamp. More...

uint32	_timeStampBase
	The initial rtp time stamp. More...

uint16	_sequenceNumberBase
	The initial sequence number. More...

uint32	_packetsSent
	The number of rtp data packets this sender has sent. More...

uint32	_bytesSent
	The number of data bytes this sender has sent. More...

Protected Attributes inherited from inet::rtp::RTPParticipantInfo
SDESChunk	_sdesChunk
	Used for storing sdes information about this RTP endsystem. More...

int	_silentIntervals
	Stores the number of rtcp intervals (including the current one) during which this RTP endsystem hasn't sent any RTP data packets. More...

Protected Attributes inherited from inet::rtp::RTPParticipantInfo_Base
IPv4Address	address

int	RTPPort

int	RTCPPort

Private Member Functions
void	copy (const RTPSenderInfo &other)

Additional Inherited Members
Static Public Member Functions inherited from inet::rtp::RTPParticipantInfo
static std::string	ssrcToName (uint32 ssrc)
	This method returns the given 32 bit ssrc identifier as an 8 character hexadecimal number which is used as name of an RTPParticipantInfo object. More...

Protected Member Functions inherited from inet::rtp::RTPParticipantInfo_Base
bool	operator== (const RTPParticipantInfo_Base &)

	RTPParticipantInfo_Base (const char *name=nullptr)

	RTPParticipantInfo_Base (const RTPParticipantInfo_Base &other)

RTPParticipantInfo_Base &	operator= (const RTPParticipantInfo_Base &other)

Detailed Description

The class RTPSenderInfo is used by an RTP end system for storing information about itself.

With the stored information it can create a SenderReport.

Constructor & Destructor Documentation

inet::rtp::RTPSenderInfo::RTPSenderInfo ( uint32 ssrc = 0 )

Default constructor.

Referenced by dup().

                                         : RTPParticipantInfo(ssrc)
 {
     _startTime = 0.0;
     _clockRate = 0;
     _timeStampBase = 0;
     _sequenceNumberBase = 0;
     _packetsSent = 0;
     _bytesSent = 0;
 }

inet::rtp::RTPSenderInfo::RTPSenderInfo ( const RTPSenderInfo & senderInfo )

Copy constructor.

                                                             : RTPParticipantInfo(senderInfo)
 {
     copy(senderInfo);
 }

inet::rtp::RTPSenderInfo::~RTPSenderInfo ( )

virtual

Destructor.

45 {

46 }

Member Function Documentation

void inet::rtp::RTPSenderInfo::copy ( const RTPSenderInfo & other )

private

Referenced by operator=(), and RTPSenderInfo().

 {
     RTPParticipantInfo::operator=(senderInfo);
     _startTime = senderInfo._startTime;
     _clockRate = senderInfo._clockRate;
     _timeStampBase = senderInfo._timeStampBase;
     _sequenceNumberBase = senderInfo._sequenceNumberBase;
     _packetsSent = senderInfo._packetsSent;
     _bytesSent = senderInfo._bytesSent;
 }

RTPSenderInfo * inet::rtp::RTPSenderInfo::dup ( ) const

overridevirtual

Duplicates this RTPSenderInfo by calling the copy constructor.

Reimplemented from inet::rtp::RTPParticipantInfo.

 {
     return new RTPSenderInfo(*this);
 }

RTPSenderInfo & inet::rtp::RTPSenderInfo::operator= ( const RTPSenderInfo & senderInfo )

Assignment operator.

 {
     if (this == &senderInfo)
         return *this;
     RTPParticipantInfo::operator=(senderInfo);
     copy(senderInfo);
     return *this;
 }

void inet::rtp::RTPSenderInfo::processReceptionReport	(	ReceptionReport *	report,
		simtime_t	arrivalTime
	)

virtual

Processes an incoming ReceptionReport for this sender.

Referenced by inet::rtp::RTCP::processIncomingRTCPReceiverReportPacket(), and inet::rtp::RTCP::processIncomingRTCPSenderReportPacket().

 {
     delete report;
 }

void inet::rtp::RTPSenderInfo::processRTPPacket	(	RTPPacket *	packet,
		int	id,
		simtime_t	arrivalTime
	)

overridevirtual

Stores information about this outgoing RTPPacket.

Reimplemented from inet::rtp::RTPParticipantInfo.

Referenced by inet::rtp::RTCP::processOutgoingRTPPacket().

 {
     _packetsSent++;
     _bytesSent = _bytesSent + packet->getPayloadLength();
 
     // call corresponding method of superclass
     // for setting _silentIntervals
     // it deletes the packet !!!
     RTPParticipantInfo::processRTPPacket(packet, id, arrivalTime);
 }

SenderReport * inet::rtp::RTPSenderInfo::senderReport ( simtime_t now )

overridevirtual

Returns a SenderReport for this rtp endsystem.

If it hasn't sent rtp data packets during the last 2 rtcp intervals, it returns nullptr.

Reimplemented from inet::rtp::RTPParticipantInfo.

Referenced by inet::rtp::RTCP::createPacket().

 {
     if (isSender()) {
         SenderReport *senderReport = new SenderReport();
         // ntp time stamp is 64 bit integer
 
         uint64 ntpSeconds = (uint64)SIMTIME_DBL(now);
         uint64 ntpFraction = (uint64)((SIMTIME_DBL(now) - ntpSeconds * 65536.0) * 65536.0);
 
         senderReport->setNTPTimeStamp((uint64)(ntpSeconds << 32) + ntpFraction);
         senderReport->setRTPTimeStamp(SIMTIME_DBL(now - _startTime) * _clockRate);
         senderReport->setPacketCount(_packetsSent);
         senderReport->setByteCount(_bytesSent);
         return senderReport;
     }
     else {
         return nullptr;
     }
 }

void inet::rtp::RTPSenderInfo::setClockRate ( int clockRate )

virtual

Sets the clock rate (in ticks per second) this sender increases the rtp time stamp.

Referenced by inet::rtp::RTCP::handleSenderModuleInitialized().

 {
     _clockRate = clockRate;
 }

void inet::rtp::RTPSenderInfo::setSequenceNumberBase ( uint16 sequenceNumberBase )

virtual

Sets the initial sequence number.

Referenced by inet::rtp::RTCP::handleSenderModuleInitialized().

 {
     _sequenceNumberBase = sequenceNumberBase;
 }

void inet::rtp::RTPSenderInfo::setStartTime ( simtime_t startTime )

virtual

Sets the time (simTime) when this endsystem has started sending rtp packets.

Referenced by inet::rtp::RTCP::handleSenderModuleInitialized().

 {
     _startTime = startTime;
 }

void inet::rtp::RTPSenderInfo::setTimeStampBase ( uint32 timeStampBase )

virtual

Sets the initial rtp time stamp.

Referenced by inet::rtp::RTCP::handleSenderModuleInitialized().

 {
     _timeStampBase = timeStampBase;
 }

Member Data Documentation

uint32 inet::rtp::RTPSenderInfo::_bytesSent

protected

The number of data bytes this sender has sent.

Referenced by copy(), processRTPPacket(), RTPSenderInfo(), and senderReport().

int inet::rtp::RTPSenderInfo::_clockRate

protected

The clock rate this sender increases the rtp time stamp.

Referenced by copy(), RTPSenderInfo(), senderReport(), and setClockRate().

uint32 inet::rtp::RTPSenderInfo::_packetsSent

protected

The number of rtp data packets this sender has sent.

Referenced by copy(), processRTPPacket(), RTPSenderInfo(), and senderReport().

uint16 inet::rtp::RTPSenderInfo::_sequenceNumberBase

protected

The initial sequence number.

Referenced by copy(), RTPSenderInfo(), and setSequenceNumberBase().

simtime_t inet::rtp::RTPSenderInfo::_startTime

protected

The time when the transmission was started.

Referenced by copy(), RTPSenderInfo(), senderReport(), and setStartTime().

uint32 inet::rtp::RTPSenderInfo::_timeStampBase

protected

The initial rtp time stamp.

Referenced by copy(), RTPSenderInfo(), and setTimeStampBase().

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

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation