inet::TCPSrvHostApp Class Reference

Hosts a server application, to be subclassed from TCPServerProcess (which is a sSimpleModule). More...

#include <TCPSrvHostApp.h>

Inheritance diagram for inet::TCPSrvHostApp:

Public Member Functions
virtual void	removeThread (TCPServerThreadBase *thread)
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	finish () override
virtual void	refreshDisplay () const override
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...

Protected Attributes
TCPSocket	serverSocket
TCPSocketMap	socketMap

Detailed Description

Hosts a server application, to be subclassed from TCPServerProcess (which is a sSimpleModule).

Creates one instance (using dynamic module creation) for each incoming connection. More info in the corresponding NED file.

Member Function Documentation

void inet::TCPSrvHostApp::finish ( )

overrideprotectedvirtual

{
}

void inet::TCPSrvHostApp::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    if (msg->isSelfMessage()) {
        TCPServerThreadBase *thread = (TCPServerThreadBase *)msg->getContextPointer();
        thread->timerExpired(msg);
    }
    else {
        TCPSocket *socket = socketMap.findSocketFor(msg);

        if (!socket) {
            // new connection -- create new socket object and server process
            socket = new TCPSocket(msg);
            socket->setOutputGate(gate("tcpOut"));

            const char *serverThreadClass = par("serverThreadClass");
            TCPServerThreadBase *proc =
                check_and_cast<TCPServerThreadBase *>(inet::utils::createOne(serverThreadClass));

            socket->setCallbackObject(proc);
            proc->init(this, socket);

            socketMap.addSocket(socket);
        }

        socket->processMessage(msg);
    }
}

virtual bool inet::TCPSrvHostApp::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

inlineoverrideprotectedvirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

    { Enter_Method_Silent(); throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName()); return true; }

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

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_APPLICATION_LAYER) {
        const char *localAddress = par("localAddress");
        int localPort = par("localPort");

        serverSocket.setOutputGate(gate("tcpOut"));
        serverSocket.readDataTransferModePar(*this);
        serverSocket.bind(localAddress[0] ? L3Address(localAddress) : L3Address(), localPort);
        serverSocket.listen();

        bool isOperational;
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
        if (!isOperational)
            throw cRuntimeError("This module doesn't support starting in node DOWN state");
    }
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::TCPSrvHostApp::refreshDisplay ( ) const

overrideprotectedvirtual

{
    char buf[32];
    sprintf(buf, "%d threads", socketMap.size());
    getDisplayString().setTagArg("t", 0, buf);
}

void inet::TCPSrvHostApp::removeThread ( TCPServerThreadBase *  thread )

virtual

Referenced by inet::TCPServerThreadBase::closed(), and inet::TCPServerThreadBase::failure().

{
    // remove socket
    socketMap.removeSocket(thread->getSocket());

    // remove thread object
    delete thread;
}

Member Data Documentation

TCPSocket inet::TCPSrvHostApp::serverSocket

protected

Referenced by initialize().

TCPSocketMap inet::TCPSrvHostApp::socketMap

protected

Referenced by handleMessage(), refreshDisplay(), and removeThread().

---

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

• TCPSrvHostApp.h
• TCPSrvHostApp.cc