inet::TCPGenericSrvApp Class Reference

Generic server application. More...

#include <TCPGenericSrvApp.h>

Inheritance diagram for inet::TCPGenericSrvApp:

Protected Member Functions
virtual void	sendBack (cMessage *msg)
virtual void	sendOrSchedule (cMessage *msg, simtime_t delay)
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
simtime_t	delay
simtime_t	maxMsgDelay
long	msgsRcvd
long	msgsSent
long	bytesRcvd
long	bytesSent

Static Protected Attributes
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")
static simsignal_t	sentPkSignal = registerSignal("sentPk")

Additional Inherited Members
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Detailed Description

Generic server application.

It serves requests coming in GenericAppMsg request messages. Clients are usually subclassed from TCPAppBase.

See also

GenericAppMsg, TCPAppBase

Member Function Documentation

void inet::TCPGenericSrvApp::finish ( )

overrideprotectedvirtual

{
    EV_INFO << getFullPath() << ": sent " << bytesSent << " bytes in " << msgsSent << " packets\n";
    EV_INFO << getFullPath() << ": received " << bytesRcvd << " bytes in " << msgsRcvd << " packets\n";
}

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

overrideprotectedvirtual

{
    if (msg->isSelfMessage()) {
        sendBack(msg);
    }
    else if (msg->getKind() == TCP_I_PEER_CLOSED) {
        // we'll close too, but only after there's surely no message
        // pending to be sent back in this connection
        msg->setName("close");
        msg->setKind(TCP_C_CLOSE);
        sendOrSchedule(msg, delay + maxMsgDelay);
    }
    else if (msg->getKind() == TCP_I_DATA || msg->getKind() == TCP_I_URGENT_DATA) {
        GenericAppMsg *appmsg = dynamic_cast<GenericAppMsg *>(msg);
        if (!appmsg)
            throw cRuntimeError("Message (%s)%s is not a GenericAppMsg -- "
                                "probably wrong client app, or wrong setting of TCP's "
                                "dataTransferMode parameters "
                                "(try \"object\")",
                    msg->getClassName(), msg->getName());

        msgsRcvd++;
        bytesRcvd += appmsg->getByteLength();
        emit(rcvdPkSignal, appmsg);

        long requestedBytes = appmsg->getExpectedReplyLength();

        simtime_t msgDelay = appmsg->getReplyDelay();
        if (msgDelay > maxMsgDelay)
            maxMsgDelay = msgDelay;

        bool doClose = appmsg->getServerClose();
        int connId = check_and_cast<TCPCommand *>(appmsg->getControlInfo())->getConnId();

        if (requestedBytes == 0) {
            delete msg;
        }
        else {
            delete appmsg->removeControlInfo();
            TCPSendCommand *cmd = new TCPSendCommand();
            cmd->setConnId(connId);
            appmsg->setControlInfo(cmd);

            // set length and send it back
            appmsg->setKind(TCP_C_SEND);
            appmsg->setByteLength(requestedBytes);
            sendOrSchedule(appmsg, delay + msgDelay);
        }

        if (doClose) {
            cMessage *msg = new cMessage("close");
            msg->setKind(TCP_C_CLOSE);
            TCPCommand *cmd = new TCPCommand();
            cmd->setConnId(connId);
            msg->setControlInfo(cmd);
            sendOrSchedule(msg, delay + maxMsgDelay);
        }
    }
    else {
        // some indication -- ignore
        EV_WARN << "drop msg: " << msg->getName() << ", kind:" << msg->getKind() << "(" << cEnum::get("inet::TcpStatusInd")->getStringFor(msg->getKind()) << ")\n";
        delete msg;
    }
}

virtual bool inet::TCPGenericSrvApp::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::TCPGenericSrvApp::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        delay = par("replyDelay");
        maxMsgDelay = 0;

        //statistics
        msgsRcvd = msgsSent = bytesRcvd = bytesSent = 0;

        WATCH(msgsRcvd);
        WATCH(msgsSent);
        WATCH(bytesRcvd);
        WATCH(bytesSent);
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        const char *localAddress = par("localAddress");
        int localPort = par("localPort");
        TCPSocket socket;
        socket.setOutputGate(gate("tcpOut"));
        socket.setDataTransferMode(TCP_TRANSFER_OBJECT);
        socket.bind(localAddress[0] ? L3AddressResolver().resolve(localAddress) : L3Address(), localPort);
        socket.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::TCPGenericSrvApp::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::TCPGenericSrvApp::refreshDisplay ( ) const

overrideprotectedvirtual

{
    char buf[64];
    sprintf(buf, "rcvd: %ld pks %ld bytes\nsent: %ld pks %ld bytes", msgsRcvd, bytesRcvd, msgsSent, bytesSent);
    getDisplayString().setTagArg("t", 0, buf);
}

void inet::TCPGenericSrvApp::sendBack ( cMessage *  msg )

protectedvirtual

Referenced by handleMessage(), and sendOrSchedule().

{
    cPacket *packet = dynamic_cast<cPacket *>(msg);

    if (packet) {
        msgsSent++;
        bytesSent += packet->getByteLength();
        emit(sentPkSignal, packet);

        EV_INFO << "sending \"" << packet->getName() << "\" to TCP, " << packet->getByteLength() << " bytes\n";
    }
    else {
        EV_INFO << "sending \"" << msg->getName() << "\" to TCP\n";
    }

    send(msg, "tcpOut");
}

void inet::TCPGenericSrvApp::sendOrSchedule ( cMessage *  msg, simtime_t  delay  )

protectedvirtual

Referenced by handleMessage().

{
    if (delay == 0)
        sendBack(msg);
    else
        scheduleAt(simTime() + delay, msg);
}

Member Data Documentation

long inet::TCPGenericSrvApp::bytesRcvd

protected

Referenced by finish(), handleMessage(), initialize(), and refreshDisplay().

long inet::TCPGenericSrvApp::bytesSent

protected

Referenced by finish(), initialize(), refreshDisplay(), and sendBack().

simtime_t inet::TCPGenericSrvApp::delay

protected

Referenced by handleMessage(), and initialize().

simtime_t inet::TCPGenericSrvApp::maxMsgDelay

protected

Referenced by handleMessage(), and initialize().

long inet::TCPGenericSrvApp::msgsRcvd

protected

Referenced by finish(), handleMessage(), initialize(), and refreshDisplay().

long inet::TCPGenericSrvApp::msgsSent

protected

Referenced by finish(), initialize(), refreshDisplay(), and sendBack().

simsignal_t inet::TCPGenericSrvApp::rcvdPkSignal = registerSignal("rcvdPk")

staticprotected

Referenced by handleMessage().

simsignal_t inet::TCPGenericSrvApp::sentPkSignal = registerSignal("sentPk")

staticprotected

Referenced by sendBack().

---

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

• TCPGenericSrvApp.h
• TCPGenericSrvApp.cc