inet::rtp::RTPPayloadReceiver Class Reference

The class RTPPayloadReceiver acts as a base class for modules processing incoming RTP data packets. More...

#include <RTPPayloadReceiver.h>

Inheritance diagram for inet::rtp::RTPPayloadReceiver:

Public Member Functions
virtual	~RTPPayloadReceiver ()
	Destructor. More...

Protected Member Functions
virtual void	initialize () override
	Initializes the receiver module, opens the output file and creates a queue for incoming packets. More...
virtual void	handleMessage (cMessage *msg) override
	Method for handling incoming packets. More...
virtual void	processPacket (RTPPacket *packet)
	Writes contents of this RTPPacket into the output file. More...
virtual void	openOutputFile (const char *fileName)
	This method is called by initialize and opens the output file stream. More...
virtual void	closeOutputFile ()
	Closes the output file stream. More...

Protected Attributes
std::ofstream	_outputFileStream
	The output file stream. More...
std::ofstream	_outputLogLoss
	The output file stream. More...
int	_payloadType
	The payload type this RTPPayloadReceiver module processes. More...

Static Protected Attributes
static simsignal_t	_rcvdPkRtpTimestampSignal = registerSignal("rcvdPkRtpTimestamp")
	An output signal used to store arrival of rtp data packets. More...

Detailed Description

The class RTPPayloadReceiver acts as a base class for modules processing incoming RTP data packets.

Constructor & Destructor Documentation

inet::rtp::RTPPayloadReceiver::~RTPPayloadReceiver ( )

virtual

Destructor.

Disposes the queue object and closes the output file.

{
    closeOutputFile();
}

Member Function Documentation

void inet::rtp::RTPPayloadReceiver::closeOutputFile ( )

protectedvirtual

Closes the output file stream.

Referenced by ~RTPPayloadReceiver().

{
    if (_outputFileStream.is_open())
        _outputFileStream.close();
    if (_outputLogLoss.is_open())
        _outputLogLoss.close();
}

void inet::rtp::RTPPayloadReceiver::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

Method for handling incoming packets.

At the moment only RTPInnerPackets containing an encapsulated RTPPacket are handled.

{
    RTPInnerPacket *rinp = check_and_cast<RTPInnerPacket *>(msg);
    if (rinp->getType() == RTP_INP_DATA_IN) {
        RTPPacket *packet = check_and_cast<RTPPacket *>(rinp->decapsulate());
        processPacket(packet);
        delete rinp;
    }
    else {
        //delete rinp;
        throw cRuntimeError("RTPInnerPacket of wrong type received");
    }
}

void inet::rtp::RTPPayloadReceiver::initialize ( )

overrideprotectedvirtual

Initializes the receiver module, opens the output file and creates a queue for incoming packets.

Subclasses must overwrite it (but should call this method too)

Reimplemented in inet::rtp::RTPAVProfilePayload32Receiver.

Referenced by inet::rtp::RTPAVProfilePayload32Receiver::initialize().

{
    const char *fileName = par("outputFileName");
    const char *logFileName = par("outputLogFileName");
    if (strcmp(fileName, ""))
        openOutputFile(fileName);
    if (strcmp(logFileName, ""))
    {
        char logName[200];
        sprintf(logName, logFileName, getId());
        _outputLogLoss.open(logName);
    }
}

void inet::rtp::RTPPayloadReceiver::openOutputFile ( const char *  fileName )

protectedvirtual

This method is called by initialize and opens the output file stream.

For most payload receivers this method works well, only when using a library for a payload type which provides an own open method it must

Referenced by initialize().

{
    _outputFileStream.open(fileName);
}

void inet::rtp::RTPPayloadReceiver::processPacket ( RTPPacket *  packet )

protectedvirtual

Writes contents of this RTPPacket into the output file.

Must be overwritten by subclasses.

Reimplemented in inet::rtp::RTPAVProfilePayload32Receiver.

Referenced by handleMessage().

{
    emit(_rcvdPkRtpTimestampSignal, (double)(packet->getTimeStamp()));
}

Member Data Documentation

std::ofstream inet::rtp::RTPPayloadReceiver::_outputFileStream

protected

The output file stream.

Referenced by closeOutputFile(), openOutputFile(), and inet::rtp::RTPAVProfilePayload32Receiver::processPacket().

std::ofstream inet::rtp::RTPPayloadReceiver::_outputLogLoss

protected

The output file stream.

Referenced by closeOutputFile(), initialize(), and inet::rtp::RTPAVProfilePayload32Receiver::processPacket().

int inet::rtp::RTPPayloadReceiver::_payloadType

protected

The payload type this RTPPayloadReceiver module processes.

Referenced by inet::rtp::RTPAVProfilePayload32Receiver::initialize().

simsignal_t inet::rtp::RTPPayloadReceiver::_rcvdPkRtpTimestampSignal = registerSignal("rcvdPkRtpTimestamp")

staticprotected

An output signal used to store arrival of rtp data packets.

Referenced by processPacket().

---

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

• RTPPayloadReceiver.h
• RTPPayloadReceiver.cc