inet::UdpVideoStreamServer Class Reference

Stream VBR video streams to clients. More...

#include <UdpVideoStreamServer.h>

Inheritance diagram for inet::UdpVideoStreamServer:

Classes
struct	VideoStreamData

Public Member Functions
	UdpVideoStreamServer ()
virtual	~UdpVideoStreamServer ()
Public Member Functions inherited from inet::ApplicationBase
	ApplicationBase ()
Public Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual	~OperationalMixin ()
	}@ More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()
Public Member Functions inherited from inet::UdpSocket::ICallback
virtual	~ICallback ()

Protected Types
typedef std::map< long int, VideoStreamData >	VideoStreamMap
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	processStreamRequest (Packet *msg)
virtual void	sendStreamData (cMessage *timer)
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	finish () override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	clearStreams ()
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
virtual void	socketDataArrived (UdpSocket *socket, Packet *packet) override
	Notifies about data arrival, packet ownership is transferred to the callee. More...
virtual void	socketErrorArrived (UdpSocket *socket, Indication *indication) override
	Notifies about error indication arrival, indication ownership is transferred to the callee. More...
virtual void	socketClosed (UdpSocket *socket) override
	Notifies about socket closed, indication ownership is transferred to the callee. More...
Protected Member Functions inherited from inet::ApplicationBase
virtual bool	isInitializeStage (int stage) const override
virtual bool	isModuleStartStage (int stage) const override
virtual bool	isModuleStopStage (int stage) const override
Protected Member Functions inherited from inet::OperationalMixin< cSimpleModule >
virtual int	numInitStages () const override
virtual void	refreshDisplay () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	handleMessageWhenDown (cMessage *msg)
virtual bool	handleOperationStage (LifecycleOperation *operation, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
virtual State	getInitialOperationalState () const
	Returns initial operational state: OPERATING or NOT_OPERATING. More...
virtual void	handleActiveOperationTimeout (cMessage *message)
virtual bool	isUp () const
	utility functions More...
virtual bool	isDown () const
virtual void	setOperationalState (State newState)
virtual void	scheduleOperationTimeout (simtime_t timeout)
virtual void	setupActiveOperation (LifecycleOperation *operation, IDoneCallback *doneCallback, State)
virtual void	delayActiveOperationFinish (simtime_t timeout)
virtual void	startActiveOperationExtraTime (simtime_t delay=SIMTIME_ZERO)
virtual void	startActiveOperationExtraTimeOrFinish (simtime_t extraTime)
virtual void	finishActiveOperation ()

Protected Attributes
VideoStreamMap	streams
UdpSocket	socket
int	localPort = -1
cPar *	sendInterval = nullptr
cPar *	packetLen = nullptr
cPar *	videoSize = nullptr
unsigned int	numStreams = 0
unsigned long	numPkSent = 0
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Static Protected Attributes
static simsignal_t	reqStreamBytesSignal = registerSignal("reqStreamBytes")

Detailed Description

Stream VBR video streams to clients.

Cooperates with UdpVideoStreamClient. UdpVideoStreamClient requests a stream and UdpVideoStreamServer starts streaming to them. Capable of handling streaming to multiple clients.

Member Typedef Documentation

VideoStreamMap

typedef std::map<long int, VideoStreamData> inet::UdpVideoStreamServer::VideoStreamMap

protected

Constructor & Destructor Documentation

UdpVideoStreamServer()

inet::UdpVideoStreamServer::UdpVideoStreamServer ( )

inline

{}

~UdpVideoStreamServer()

inet::UdpVideoStreamServer::~UdpVideoStreamServer ( )

virtual

{
    for (auto& elem : streams)
        cancelAndDelete(elem.second.timer);
}

Member Function Documentation

clearStreams()

void inet::UdpVideoStreamServer::clearStreams ( )

protectedvirtual

{
    for (auto& elem : streams)
        cancelAndDelete(elem.second.timer);
    streams.clear();
}

Referenced by handleCrashOperation(), and handleStopOperation().

finish()

void inet::UdpVideoStreamServer::finish ( )

overrideprotectedvirtual

{
}

handleCrashOperation()

void inet::UdpVideoStreamServer::handleCrashOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    clearStreams();
    if (operation->getRootModule() != getContainingNode(this)) // closes socket when the application crashed only
        socket.destroy(); // TODO  in real operating systems, program crash detected by OS and OS closes sockets of crashed programs.
    socket.setCallback(nullptr);
}

handleMessageWhenUp()

void inet::UdpVideoStreamServer::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg->isSelfMessage()) {
        // timer for a particular video stream expired, send packet
        sendStreamData(msg);
    }
    else
        socket.processMessage(msg);
}

handleStartOperation()

void inet::UdpVideoStreamServer::handleStartOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    socket.setOutputGate(gate("socketOut"));
    socket.setCallback(this);
    socket.bind(localPort);
 
    int timeToLive = par("timeToLive");
    if (timeToLive != -1)
        socket.setTimeToLive(timeToLive);
 
    int dscp = par("dscp");
    if (dscp != -1)
        socket.setDscp(dscp);
 
    int tos = par("tos");
    if (tos != -1)
        socket.setTos(tos);
}

handleStopOperation()

void inet::UdpVideoStreamServer::handleStopOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    clearStreams();
    socket.setCallback(nullptr);
    socket.close();
    delayActiveOperationFinish(par("stopOperationTimeout"));
}

initialize()

void inet::UdpVideoStreamServer::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    ApplicationBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        sendInterval = &par("sendInterval");
        packetLen = &par("packetLen");
        videoSize = &par("videoSize");
        localPort = par("localPort");
 
        // statistics
        numStreams = 0;
        numPkSent = 0;
 
        WATCH_MAP(streams);
    }
}

numInitStages()

virtual int inet::UdpVideoStreamServer::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

processStreamRequest()

void inet::UdpVideoStreamServer::processStreamRequest ( Packet *  msg )

protectedvirtual

{
    // register video stream...
    cMessage *timer = new cMessage("VideoStreamTmr");
    VideoStreamData *d = &streams[timer->getId()];
    d->timer = timer;
    d->clientAddr = msg->getTag<L3AddressInd>()->getSrcAddress();
    d->clientPort = msg->getTag<L4PortInd>()->getSrcPort();
    d->videoSize = (*videoSize);
    d->bytesLeft = d->videoSize;
    d->numPkSent = 0;
    ASSERT(d->videoSize > 0);
    delete msg;
 
    numStreams++;
    emit(reqStreamBytesSignal, d->videoSize);
 
    // ... then transmit first packet right away
    sendStreamData(timer);
}

Referenced by socketDataArrived().

sendStreamData()

void inet::UdpVideoStreamServer::sendStreamData ( cMessage *  timer )

protectedvirtual

{
    auto it = streams.find(timer->getId());
    if (it == streams.end())
        throw cRuntimeError("Model error: Stream not found for timer");
 
    VideoStreamData *d = &(it->second);
 
    // generate and send a packet
    Packet *pkt = new Packet("VideoStrmPk");
    long pktLen = *packetLen;
 
    if (pktLen > d->bytesLeft)
        pktLen = d->bytesLeft;
    const auto& payload = makeShared<ByteCountChunk>(B(pktLen));
    payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
    pkt->insertAtBack(payload);
 
    emit(packetSentSignal, pkt);
    socket.sendTo(pkt, d->clientAddr, d->clientPort);
 
    d->bytesLeft -= pktLen;
    d->numPkSent++;
    numPkSent++;
 
    // reschedule timer if there's bytes left to send
    if (d->bytesLeft > 0) {
        simtime_t interval = (*sendInterval);
        scheduleAfter(interval, timer);
    }
    else {
        streams.erase(it);
        delete timer;
    }
}

Referenced by handleMessageWhenUp(), and processStreamRequest().

socketClosed()

void inet::UdpVideoStreamServer::socketClosed ( UdpSocket *  socket )

overrideprotectedvirtual

Notifies about socket closed, indication ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    if (operationalState == State::STOPPING_OPERATION)
        startActiveOperationExtraTimeOrFinish(par("stopOperationExtraTime"));
}

socketDataArrived()

void inet::UdpVideoStreamServer::socketDataArrived ( UdpSocket *  socket, Packet *  packet  )

overrideprotectedvirtual

Notifies about data arrival, packet ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    // process incoming packet
    processStreamRequest(packet);
}

socketErrorArrived()

void inet::UdpVideoStreamServer::socketErrorArrived ( UdpSocket *  socket, Indication *  indication  )

overrideprotectedvirtual

Notifies about error indication arrival, indication ownership is transferred to the callee.

Implements inet::UdpSocket::ICallback.

{
    EV_WARN << "Ignoring UDP error report " << indication->getName() << endl;
    delete indication;
}

Member Data Documentation

localPort

int inet::UdpVideoStreamServer::localPort = -1

protected

Referenced by handleStartOperation(), and initialize().

numPkSent

unsigned long inet::UdpVideoStreamServer::numPkSent = 0

protected

Referenced by initialize(), and sendStreamData().

numStreams

unsigned int inet::UdpVideoStreamServer::numStreams = 0

protected

Referenced by initialize(), and processStreamRequest().

packetLen

cPar* inet::UdpVideoStreamServer::packetLen = nullptr

protected

Referenced by initialize(), and sendStreamData().

reqStreamBytesSignal

simsignal_t inet::UdpVideoStreamServer::reqStreamBytesSignal = registerSignal("reqStreamBytes")

staticprotected

Referenced by processStreamRequest().

sendInterval

cPar* inet::UdpVideoStreamServer::sendInterval = nullptr

protected

Referenced by initialize().

socket

UdpSocket inet::UdpVideoStreamServer::socket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStartOperation(), handleStopOperation(), and sendStreamData().

streams

VideoStreamMap inet::UdpVideoStreamServer::streams

protected

Referenced by clearStreams(), initialize(), processStreamRequest(), sendStreamData(), and ~UdpVideoStreamServer().

videoSize

cPar* inet::UdpVideoStreamServer::videoSize = nullptr

protected

Referenced by initialize().

---

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

• UdpVideoStreamServer.h
• UdpVideoStreamServer.cc