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::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::TcpSocket::ICallback
virtual	~ICallback ()

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	handleTimer (cMessage *msg) override

virtual void	socketEstablished (TcpSocket *socket) override

virtual void	socketDataArrived (TcpSocket socket, Packet msg, bool urgent) override
	Notifies about data arrival, packet ownership is transferred to the callee. More...

virtual void	socketClosed (TcpSocket *socket) override

virtual void	socketFailure (TcpSocket *socket, int code) override

virtual void	checkedScheduleAt (simtime_t t, cMessage *msg)

virtual void	sendGenericAppMsg (int numBytes, int expectedReplyBytes)

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

Protected Member Functions inherited from inet::TcpAppBase
virtual void	handleMessageWhenUp (cMessage *msg) override

virtual void	finish () override

virtual void	refreshDisplay () const override

virtual void	connect ()

virtual void	close ()

virtual void	sendPacket (Packet *pkt)

virtual void	socketAvailable (TcpSocket socket, TcpAvailableInfo availableInfo) override

virtual void	socketPeerClosed (TcpSocket *socket) override

virtual void	socketStatusArrived (TcpSocket socket, TcpStatusInfo status) override

virtual void	socketDeleted (TcpSocket *socket) override

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
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

Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout

cMessage *	activeOperationExtraTimer

Additional Inherited Members
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Static Protected Attributes inherited from inet::TcpAppBase
static simsignal_t	connectSignal = registerSignal("connect")

Detailed Description

An example Telnet client application.

The server app should be TcpGenericServerApp.

Constructor & Destructor Documentation

◆ TelnetApp()

inet::TelnetApp::TelnetApp ( )

inline

43 {}

◆ ~TelnetApp()

inet::TelnetApp::~TelnetApp ( )

virtual

 {
     cancelAndDelete(timeoutMsg);
 }

Member Function Documentation

◆ checkedScheduleAt()

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

protectedvirtual

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

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

◆ handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

 {
     cancelEvent(timeoutMsg);
     if (operation->getRootModule() != getContainingNode(this))
         socket.destroy();
 }

◆ handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

 {
     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);
     }
 }

◆ handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

 {
     cancelEvent(timeoutMsg);
     if (socket.isOpen()) {
         close();
         delayActiveOperationFinish(par("stopOperationTimeout"));
     }
 }

◆ handleTimer()

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() + 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 + par("commandOutputLength").intValue());
                 numCharsToType = 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;
     }
 }

◆ initialize()

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);
         simtime_t startTime = par("startTime");
         stopTime = par("stopTime");
         if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
             throw cRuntimeError("Invalid startTime/stopTime parameters");
         timeoutMsg = new cMessage("timer");
     }
 }

◆ numInitStages()

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

inlineoverrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

28 { return NUM_INIT_STAGES; }

◆ sendGenericAppMsg()

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

protectedvirtual

 {
     EV_INFO << "sending " << numBytes << " bytes, expecting " << expectedReplyBytes << endl;
  
     const auto& payload = makeShared<GenericAppMsg>();
     Packet *packet = new Packet("data");
     payload->setChunkLength(B(numBytes));
     payload->setExpectedReplyLength(B(expectedReplyBytes));
     payload->setServerClose(false);
     payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
     packet->insertAtBack(payload);
  
     sendPacket(packet);
 }

Referenced by handleTimer().

◆ socketClosed()

void inet::TelnetApp::socketClosed ( TcpSocket * socket )

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

 {
     TcpAppBase::socketClosed(socket);
     cancelEvent(timeoutMsg);
     if (operationalState == State::OPERATING) {
         // start another session after a delay
         timeoutMsg->setKind(MSGKIND_CONNECT);
         checkedScheduleAt(simTime() + par("idleInterval"), timeoutMsg);
     }
     else if (operationalState == State::STOPPING_OPERATION) {
         if (!this->socket.isOpen())
             startActiveOperationExtraTimeOrFinish(par("stopOperationExtraTime"));
     }
 }

◆ socketDataArrived()

void inet::TelnetApp::socketDataArrived	(	TcpSocket *	socket,
		Packet *	packet,
		bool	urgent
	)

overrideprotectedvirtual

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

Reimplemented from inet::TcpAppBase.

 {
     int len = msg->getByteLength();
     TcpAppBase::socketDataArrived(socket, 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";
             if (timeoutMsg->isScheduled())
                 cancelEvent(timeoutMsg);
             timeoutMsg->setKind(MSGKIND_CLOSE);
             checkedScheduleAt(simTime() + par("thinkTime"), timeoutMsg);
         }
         else {
             EV_INFO << "user looks at output, then starts typing next command\n";
             if (!timeoutMsg->isScheduled()) {
                 timeoutMsg->setKind(MSGKIND_SEND);
                 checkedScheduleAt(simTime() + par("thinkTime"), timeoutMsg);
             }
         }
     }
 }

◆ socketEstablished()

void inet::TelnetApp::socketEstablished ( TcpSocket * socket )

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

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

◆ socketFailure()

void inet::TelnetApp::socketFailure	(	TcpSocket *	socket,
		int	code
	)

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

 {
     TcpAppBase::socketFailure(socket, code);
  
     // reconnect after a delay
     cancelEvent(timeoutMsg);
     timeoutMsg->setKind(MSGKIND_CONNECT);
     checkedScheduleAt(simTime() + par("reconnectInterval"), timeoutMsg);
 }

Member Data Documentation

◆ numCharsToType

int inet::TelnetApp::numCharsToType = 0

protected

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

◆ numLinesToType

int inet::TelnetApp::numLinesToType = 0

protected

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

◆ stopTime

simtime_t inet::TelnetApp::stopTime

protected

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

◆ timeoutMsg

cMessage* inet::TelnetApp::timeoutMsg = nullptr

protected

Referenced by handleCrashOperation(), handleStartOperation(), handleStopOperation(), handleTimer(), initialize(), socketClosed(), socketDataArrived(), socketEstablished(), socketFailure(), and ~TelnetApp().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TelnetApp()

◆ ~TelnetApp()

Member Function Documentation

◆ checkedScheduleAt()

◆ handleCrashOperation()

◆ handleStartOperation()

◆ handleStopOperation()

◆ handleTimer()

◆ initialize()

◆ numInitStages()

◆ sendGenericAppMsg()

◆ socketClosed()

◆ socketDataArrived()

◆ socketEstablished()

◆ socketFailure()

Member Data Documentation

◆ numCharsToType

◆ numLinesToType

◆ stopTime

◆ timeoutMsg