inet::TelnetApp Class Reference

An example Telnet client application. More...

#include <TelnetApp.h>

Inheritance diagram for inet::TelnetApp:

Public Member Functions
	TelnetApp ()
virtual	~TelnetApp ()
Public Member Functions inherited from inet::TCPSocket::CallbackInterface
virtual	~CallbackInterface ()
virtual void	socketDeleted (int connId, void *yourPtr)
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleTimer (cMessage *msg) override
virtual void	socketEstablished (int connId, void *yourPtr) override
virtual void	socketDataArrived (int connId, void *yourPtr, cPacket *msg, bool urgent) override
virtual void	socketClosed (int connId, void *yourPtr) override
virtual void	socketFailure (int connId, void *yourPtr, int code) override
virtual void	checkedScheduleAt (simtime_t t, cMessage *msg)
virtual void	sendGenericAppMsg (int numBytes, int expectedReplyBytes)
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
Protected Member Functions inherited from inet::TCPAppBase
virtual void	handleMessage (cMessage *msg) override
virtual void	finish () override
virtual void	refreshDisplay () const override
virtual void	connect ()
virtual void	close ()
virtual void	sendPacket (cPacket *pkt)
virtual void	socketPeerClosed (int connId, void *yourPtr) override
virtual void	socketStatusArrived (int connId, void *yourPtr, TCPStatusInfo *status) override

Protected Attributes
cMessage *	timeoutMsg = nullptr
int	numLinesToType = 0
int	numCharsToType = 0
simtime_t	stopTime
Protected Attributes inherited from inet::TCPAppBase
TCPSocket	socket
int	numSessions
int	numBroken
int	packetsSent
int	packetsRcvd
int	bytesSent
int	bytesRcvd

Additional Inherited Members
Static Protected Attributes inherited from inet::TCPAppBase
static simsignal_t	connectSignal = registerSignal("connect")
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")
static simsignal_t	sentPkSignal = registerSignal("sentPk")

Detailed Description

An example Telnet client application.

The server app should be TCPGenericSrvApp.

Constructor & Destructor Documentation

inet::TelnetApp::TelnetApp ( )

inline

{}

inet::TelnetApp::~TelnetApp ( )

virtual

{
    cancelAndDelete(timeoutMsg);
}

Member Function Documentation

void inet::TelnetApp::checkedScheduleAt ( simtime_t  t, cMessage *  msg  )

protectedvirtual

Referenced by handleTimer(), socketClosed(), socketDataArrived(), socketEstablished(), and socketFailure().

{
    if (stopTime < SIMTIME_ZERO || t < stopTime)
        scheduleAt(t, msg);
}

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

overrideprotectedvirtual

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();
    if (dynamic_cast<NodeStartOperation *>(operation)) {
        if ((NodeStartOperation::Stage)stage == NodeStartOperation::STAGE_APPLICATION_LAYER) {
            simtime_t now = simTime();
            simtime_t startTime = par("startTime");
            simtime_t start = std::max(startTime, now);
            if (timeoutMsg && ((stopTime < SIMTIME_ZERO) || (start < stopTime) || (start == stopTime && startTime == stopTime))) {
                timeoutMsg->setKind(MSGKIND_CONNECT);
                scheduleAt(start, timeoutMsg);
            }
        }
    }
    else if (dynamic_cast<NodeShutdownOperation *>(operation)) {
        if ((NodeShutdownOperation::Stage)stage == NodeShutdownOperation::STAGE_APPLICATION_LAYER) {
            cancelEvent(timeoutMsg);
            if (socket.getState() == TCPSocket::CONNECTED || socket.getState() == TCPSocket::CONNECTING || socket.getState() == TCPSocket::PEER_CLOSED)
                close();
            // TODO: wait until socket is closed
        }
    }
    else if (dynamic_cast<NodeCrashOperation *>(operation)) {
        if ((NodeCrashOperation::Stage)stage == NodeCrashOperation::STAGE_CRASH)
            cancelEvent(timeoutMsg);
    }
    else
        throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName());
    return true;
}

void inet::TelnetApp::handleTimer ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::TCPAppBase.

{
    switch (msg->getKind()) {
        case MSGKIND_CONNECT:
            EV_INFO << "user fires up telnet program\n";
            connect();
            break;

        case MSGKIND_SEND:
            if (numCharsToType > 0) {
                // user types a character and expects it to be echoed
                EV_INFO << "user types one character, " << numCharsToType - 1 << " more to go\n";
                sendGenericAppMsg(1, 1);
                checkedScheduleAt(simTime() + (simtime_t)par("keyPressDelay"), timeoutMsg);
                numCharsToType--;
            }
            else {
                EV_INFO << "user hits Enter key\n";
                // Note: reply length must be at least 2, otherwise we'll think
                // it's an echo when it comes back!
                sendGenericAppMsg(1, 2 + (long)par("commandOutputLength"));
                numCharsToType = (long)par("commandLength");

                // Note: no checkedScheduleAt(), because user only starts typing next command
                // when output from previous one has arrived (see socketDataArrived())
            }
            break;

        case MSGKIND_CLOSE:
            EV_INFO << "user exits telnet program\n";
            close();
            break;
    }
}

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

overrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{
    TCPAppBase::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        numCharsToType = numLinesToType = 0;
        WATCH(numCharsToType);
        WATCH(numLinesToType);
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        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");

        simtime_t startTime = par("startTime");
        stopTime = par("stopTime");
        if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");

        timeoutMsg = new cMessage("timer");
        timeoutMsg->setKind(MSGKIND_CONNECT);
        scheduleAt(startTime, timeoutMsg);
    }
}

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

inlineoverrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{ return NUM_INIT_STAGES; }

void inet::TelnetApp::sendGenericAppMsg ( int  numBytes, int  expectedReplyBytes  )

protectedvirtual

Referenced by handleTimer().

{
    EV_INFO << "sending " << numBytes << " bytes, expecting " << expectedReplyBytes << endl;

    GenericAppMsg *msg = new GenericAppMsg("data");
    msg->setByteLength(numBytes);
    msg->setExpectedReplyLength(expectedReplyBytes);
    msg->setServerClose(false);
    sendPacket(msg);
}

void inet::TelnetApp::socketClosed ( int  connId, void *  yourPtr  )

overrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{
    TCPAppBase::socketClosed(connId, ptr);

    // start another session after a delay
    cancelEvent(timeoutMsg);
    timeoutMsg->setKind(MSGKIND_CONNECT);
    checkedScheduleAt(simTime() + (simtime_t)par("idleInterval"), timeoutMsg);
}

void inet::TelnetApp::socketDataArrived ( int  connId, void *  yourPtr, cPacket *  msg, bool  urgent  )

overrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{
    int len = msg->getByteLength();
    TCPAppBase::socketDataArrived(connId, ptr, msg, urgent);

    if (len == 1) {
        // this is an echo, ignore
        EV_INFO << "received echo\n";
    }
    else {
        // output from last typed command arrived.
        EV_INFO << "received output of command typed\n";

        // If user has finished working, she closes the connection, otherwise
        // starts typing again after a delay
        numLinesToType--;

        if (numLinesToType == 0) {
            EV_INFO << "user has no more commands to type\n";
            timeoutMsg->setKind(MSGKIND_CLOSE);
            checkedScheduleAt(simTime() + (simtime_t)par("thinkTime"), timeoutMsg);
        }
        else {
            EV_INFO << "user looks at output, then starts typing next command\n";
            timeoutMsg->setKind(MSGKIND_SEND);
            checkedScheduleAt(simTime() + (simtime_t)par("thinkTime"), timeoutMsg);
        }
    }
}

void inet::TelnetApp::socketEstablished ( int  connId, void *  yourPtr  )

overrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{
    TCPAppBase::socketEstablished(connId, ptr);

    // schedule first sending
    numLinesToType = (long)par("numCommands");
    numCharsToType = (long)par("commandLength");
    timeoutMsg->setKind(numLinesToType > 0 ? MSGKIND_SEND : MSGKIND_CLOSE);
    checkedScheduleAt(simTime() + (simtime_t)par("thinkTime"), timeoutMsg);
}

void inet::TelnetApp::socketFailure ( int  connId, void *  yourPtr, int  code  )

overrideprotectedvirtual

Reimplemented from inet::TCPAppBase.

{
    TCPAppBase::socketFailure(connId, ptr, code);

    // reconnect after a delay
    cancelEvent(timeoutMsg);
    timeoutMsg->setKind(MSGKIND_CONNECT);
    checkedScheduleAt(simTime() + (simtime_t)par("reconnectInterval"), timeoutMsg);
}

Member Data Documentation

int inet::TelnetApp::numCharsToType = 0

protected

Referenced by handleTimer(), initialize(), and socketEstablished().

int inet::TelnetApp::numLinesToType = 0

protected

Referenced by initialize(), socketDataArrived(), and socketEstablished().

simtime_t inet::TelnetApp::stopTime

protected

Referenced by checkedScheduleAt(), handleOperationStage(), and initialize().

cMessage* inet::TelnetApp::timeoutMsg = nullptr

protected

Referenced by handleOperationStage(), handleTimer(), initialize(), socketClosed(), socketDataArrived(), socketEstablished(), socketFailure(), and ~TelnetApp().

---

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

• TelnetApp.h
• TelnetApp.cc