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

#include <RTPInnerPacket.h>

Inheritance diagram for inet::rtp::RTPInnerPacket:

Public Member Functions
	RTPInnerPacket (const char *name=nullptr, int kind=0)

	RTPInnerPacket (const RTPInnerPacket &other)

RTPInnerPacket &	operator= (const RTPInnerPacket &other)

virtual RTPInnerPacket *	dup () const override

virtual std::string	info () const override
	Writes a short info about this RTPInnerPacket into the given string. More...

virtual void	dump (std::ostream &os) const
	Writes a longer info about this RTPInnerPacket into the given output stream. More...

virtual void	setInitializeProfilePkt (int mtu)
	Called by the rtp module after creating the profile module. More...

virtual void	setProfileInitializedPkt (int rtcpPercentage, int port)
	Called by the profile module after it has received the initializeProfile() message. More...

virtual void	setInitializeRTCPPkt (const char *commonName, int mtu, int bandwidth, int rtcpPercentage, IPv4Address address, int port)
	Called by the rtp module to inform the rtcp module about mandatory information for starting the rtp session. More...

virtual void	setRtcpInitializedPkt (uint32 ssrc)
	Called by the rtcp module after it has waited for half an rtcp interval for incoming messages from other session participants. More...

virtual void	setCreateSenderModulePkt (uint32 ssrc, int payloadType, const char *fileName)

virtual void	setSenderModuleCreatedPkt (uint32 ssrc)

virtual void	setDeleteSenderModulePkt (uint32 ssrc)

virtual void	setSenderModuleDeletedPkt (uint32 ssrc)

virtual void	setInitializeSenderModulePkt (uint32 ssrc, const char *fileName, int mtu)

virtual void	setSenderModuleInitializedPkt (uint32 ssrc, int payloadType, int clockRate, int timeStampBase, int sequenceNumberBase)

virtual void	setSenderModuleControlPkt (uint32 ssrc, RTPSenderControlMessage *msg)

virtual void	setSenderModuleStatusPkt (uint32 ssrc, RTPSenderStatusMessage *msg)

virtual void	setLeaveSessionPkt ()
	Called by the rtp module to inform the rtcp module that the session should be left. More...

virtual void	setSessionLeftPkt ()
	Called by the rtcp module when the rtcp bye packet has been sent to the network. More...

virtual void	setDataOutPkt (RTPPacket *packet)
	Capsulates the outgoing RTPPacket into this RTPInnerPacket to transport it within the rtp layer. More...

virtual void	setDataInPkt (RTPPacket *packet, IPv4Address address, int port)
	Capsultes the incoming RTPPacket into this RTPInnerPacket to transport it within the rtp layer. More...

virtual int	getMTU () const
	Returns the maximum transmission unit stored in this RTPInnerPacket. More...

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

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

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

virtual short	getType () const

virtual void	setType (short type)

virtual const char *	getCommonName () const

virtual void	setCommonName (const char *commonName)

virtual int	getMtu () const

virtual void	setMtu (int mtu)

virtual int	getBandwidth () const

virtual void	setBandwidth (int bandwidth)

virtual int	getRtcpPercentage () const

virtual void	setRtcpPercentage (int rtcpPercentage)

virtual IPv4Address &	getAddress ()

virtual const IPv4Address &	getAddress () const

virtual void	setAddress (const IPv4Address &address)

virtual int	getPort () const

virtual void	setPort (int port)

virtual uint32_t	getSsrc () const

virtual void	setSsrc (uint32_t ssrc)

virtual int	getPayloadType () const

virtual void	setPayloadType (int payloadType)

virtual const char *	getFileName () const

virtual void	setFileName (const char *fileName)

virtual int	getClockRate () const

virtual void	setClockRate (int clockRate)

virtual int	getTimeStampBase () const

virtual void	setTimeStampBase (int timeStampBase)

virtual int	getSequenceNumberBase () const

virtual void	setSequenceNumberBase (int sequenceNumberBase)

Additional Inherited Members
Protected Member Functions inherited from inet::rtp::RTPInnerPacket_Base
bool	operator== (const RTPInnerPacket_Base &)

	RTPInnerPacket_Base (const char *name=nullptr, short kind=0)

	RTPInnerPacket_Base (const RTPInnerPacket_Base &other)

RTPInnerPacket_Base &	operator= (const RTPInnerPacket_Base &other)

Protected Attributes inherited from inet::rtp::RTPInnerPacket_Base
short	type

::omnetpp::opp_string	commonName

int	mtu

int	bandwidth

int	rtcpPercentage

IPv4Address	address

int	port

uint32_t	ssrc

int	payloadType

::omnetpp::opp_string	fileName

int	clockRate

int	timeStampBase

int	sequenceNumberBase

Detailed Description

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

Constructor & Destructor Documentation

inet::rtp::RTPInnerPacket::RTPInnerPacket	(	const char *	name = `nullptr`,
		int	kind = `0`
	)

inline

33 : RTPInnerPacket_Base(name, kind) {}

inet::rtp::RTPInnerPacket_Base::RTPInnerPacket_Base

RTPInnerPacket_Base(const char *name=nullptr, short kind=0)

inet::rtp::RTPInnerPacket::RTPInnerPacket ( const RTPInnerPacket & other )

inline

34 : RTPInnerPacket_Base(other) {}

inet::rtp::RTPInnerPacket_Base::RTPInnerPacket_Base

RTPInnerPacket_Base(const char *name=nullptr, short kind=0)

Member Function Documentation

void inet::rtp::RTPInnerPacket::dump ( std::ostream & os ) const

virtual

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

 {
     os << "RTPInnerPacket:" << endl;
     os << "  type = " << type << endl;
     os << "  commonName = " << commonName << endl;
     os << "  mtu = " << mtu << endl;
     os << "  bandwidth = " << bandwidth << endl;
     os << "  rtcpPercentage = " << rtcpPercentage << endl;
     os << "  address = " << address << endl;
     os << "  port = " << port << endl;
     os << "  ssrc = " << ssrc << endl;
     os << "  payloadType = " << payloadType << endl;
     os << "  fileName = " << fileName << endl;
     os << "  clockRate = " << clockRate << endl;
     os << "  timeStampBase = " << timeStampBase << endl;
     os << "  sequenceNumberBase = " << sequenceNumberBase << endl;
 }

virtual RTPInnerPacket* inet::rtp::RTPInnerPacket::dup ( ) const

inlineoverridevirtual

Reimplemented from inet::rtp::RTPInnerPacket_Base.

Referenced by inet::rtp::RTP::dataOut().

36 { return new RTPInnerPacket(*this); }

inet::rtp::RTPInnerPacket::RTPInnerPacket

RTPInnerPacket(const char *name=nullptr, int kind=0)

Definition: RTPInnerPacket.h:33

virtual int inet::rtp::RTPInnerPacket::getMTU ( ) const

inlinevirtual

Returns the maximum transmission unit stored in this RTPInnerPacket.

Referenced by inet::rtp::RTCP::handleInitializeRTCP(), inet::rtp::RTPProfile::initializeProfile(), and inet::rtp::RTPPayloadSender::initializeSenderModule().

116 { return getMtu(); }

inet::rtp::RTPInnerPacket_Base::getMtu

virtual int getMtu() const

std::string inet::rtp::RTPInnerPacket::info ( ) const

overridevirtual

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

 {
     std::stringstream out;
     out << "RTPInnerPacket: type=" << type;
     return out.str();
 }

RTPInnerPacket& inet::rtp::RTPInnerPacket::operator= ( const RTPInnerPacket & other )

inline

35 { RTPInnerPacket_Base::operator=(other); return *this; }

inet::rtp::RTPInnerPacket_Base::operator=

RTPInnerPacket_Base & operator=(const RTPInnerPacket_Base &other)

void inet::rtp::RTPInnerPacket::setCreateSenderModulePkt	(	uint32	ssrc,
		int	payloadType,
		const char *	fileName
	)

virtual

Referenced by inet::rtp::RTP::createSenderModule().

 {
     type = RTP_INP_CREATE_SENDER_MODULE;
     ssrc = ssrc_par;
     payloadType = payloadType_par;
     fileName = fileName_par;
 }

void inet::rtp::RTPInnerPacket::setDataInPkt	(	RTPPacket *	packet,
		IPv4Address	address,
		int	port
	)

virtual

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

Referenced by inet::rtp::RTP::readRet().

 {
     type = RTP_INP_DATA_IN;
     address = address_par;
     port = port_par;
     encapsulate(packet);
 }

void inet::rtp::RTPInnerPacket::setDataOutPkt ( RTPPacket * packet )

virtual

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

Referenced by inet::rtp::RTPAVProfilePayload32Sender::sendPacket().

 {
     type = RTP_INP_DATA_OUT;
     encapsulate(packet);
 }

void inet::rtp::RTPInnerPacket::setDeleteSenderModulePkt ( uint32 ssrc )

virtual

Referenced by inet::rtp::RTP::deleteSenderModule().

 {
     type = RTP_INP_DELETE_SENDER_MODULE;
     ssrc = ssrc_par;
 }

void inet::rtp::RTPInnerPacket::setInitializeProfilePkt ( 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.

Referenced by inet::rtp::RTP::initializeProfile().

 {
     type = RTP_INP_INITIALIZE_PROFILE;
     mtu = mtu_par;
 }

void inet::rtp::RTPInnerPacket::setInitializeRTCPPkt	(	const char *	commonName,
		int	mtu,
		int	bandwidth,
		int	rtcpPercentage,
		IPv4Address	address,
		int	port
	)

virtual

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

Referenced by inet::rtp::RTP::initializeRTCP().

 {
     type = RTP_INP_INITIALIZE_RTCP;
     commonName = commonName_par;
     mtu = mtu_par;
     bandwidth = bandwidth_par;
     rtcpPercentage = rtcpPercentage_par;
     address = address_par;
     port = port_par;
 }

void inet::rtp::RTPInnerPacket::setInitializeSenderModulePkt	(	uint32	ssrc,
		const char *	fileName,
		int	mtu
	)

virtual

Referenced by inet::rtp::RTPProfile::createSenderModule().

 {
     type = RTP_INP_INITIALIZE_SENDER_MODULE;
     ssrc = ssrc_par;
     fileName = fileName_par;
     mtu = mtu_par;
 }

void inet::rtp::RTPInnerPacket::setLeaveSessionPkt ( )

virtual

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

Referenced by inet::rtp::RTP::leaveSession().

 {
     type = RTP_INP_LEAVE_SESSION;
 }

void inet::rtp::RTPInnerPacket::setProfileInitializedPkt	(	int	rtcpPercentage,
		int	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.

Referenced by inet::rtp::RTPProfile::initializeProfile().

 {
     type = RTP_INP_PROFILE_INITIALIZED;
     rtcpPercentage = rtcpPercentage_par;
     port = port_par;
 }

void inet::rtp::RTPInnerPacket::setRtcpInitializedPkt ( uint32 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

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

 {
     type = RTP_INP_RTCP_INITIALIZED;
     ssrc = ssrc_par;
 }

void inet::rtp::RTPInnerPacket::setSenderModuleControlPkt	(	uint32	ssrc,
		RTPSenderControlMessage *	msg
	)

virtual

Referenced by inet::rtp::RTP::senderModuleControl().

 {
     type = RTP_INP_SENDER_MODULE_CONTROL;
     ssrc = ssrc_par;
     encapsulate(msg);
 }

void inet::rtp::RTPInnerPacket::setSenderModuleCreatedPkt ( uint32 ssrc )

virtual

Referenced by inet::rtp::RTPProfile::createSenderModule().

 {
     type = RTP_INP_SENDER_MODULE_CREATED;
     ssrc = ssrc_par;
 }

void inet::rtp::RTPInnerPacket::setSenderModuleDeletedPkt ( uint32 ssrc )

virtual

Referenced by inet::rtp::RTPProfile::deleteSenderModule().

 {
     type = RTP_INP_SENDER_MODULE_DELETED;
     ssrc = ssrc_par;
 }

void inet::rtp::RTPInnerPacket::setSenderModuleInitializedPkt	(	uint32	ssrc,
		int	payloadType,
		int	clockRate,
		int	timeStampBase,
		int	sequenceNumberBase
	)

virtual

Referenced by inet::rtp::RTPPayloadSender::initializeSenderModule().

 {
     type = RTP_INP_SENDER_MODULE_INITIALIZED;
     ssrc = ssrc_par;
     payloadType = payloadType_par;
     clockRate = clockRate_par;
     timeStampBase = timeStampBase_par;
     sequenceNumberBase = sequenceNumberBase_par;
 }

void inet::rtp::RTPInnerPacket::setSenderModuleStatusPkt	(	uint32	ssrc,
		RTPSenderStatusMessage *	msg
	)

virtual

Referenced by inet::rtp::RTPPayloadSender::endOfFile(), inet::rtp::RTPPayloadSender::pause(), inet::rtp::RTPPayloadSender::play(), and inet::rtp::RTPPayloadSender::stop().

 {
     type = RTP_INP_SENDER_MODULE_STATUS;
     ssrc = ssrc_par;
     encapsulate(msg);
 }

void inet::rtp::RTPInnerPacket::setSessionLeftPkt ( )

virtual

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

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

 {
     type = RTP_INP_SESSION_LEFT;
 }

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation