Base class for clients app for TCP-based request-reply protocols or apps. More...

#include <TCPAppBase.h>

Inheritance diagram for inet::TCPAppBase:

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 void	connect ()

virtual void	close ()

virtual void	sendPacket (cPacket *pkt)

virtual void	handleTimer (cMessage *msg)=0

virtual void	socketEstablished (int connId, void *yourPtr) override

virtual void	socketDataArrived (int connId, void yourPtr, cPacket msg, bool urgent) override

virtual void	socketPeerClosed (int connId, void *yourPtr) override

virtual void	socketClosed (int connId, void *yourPtr) override

virtual void	socketFailure (int connId, void *yourPtr, int code) override

virtual void	socketStatusArrived (int connId, void yourPtr, TCPStatusInfo status) override

Protected Attributes
TCPSocket	socket

int	numSessions

int	numBroken

int	packetsSent

int	packetsRcvd

int	bytesSent

int	bytesRcvd

Static Protected Attributes
static simsignal_t	connectSignal = registerSignal("connect")

static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")

static simsignal_t	sentPkSignal = registerSignal("sentPk")

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

virtual void	socketDeleted (int connId, void *yourPtr)

Detailed Description

Base class for clients app for TCP-based request-reply protocols or apps.

Handles a single session (and TCP connection) at a time.

It needs the following NED parameters: localAddress, localPort, connectAddress, connectPort.

Member Function Documentation

void inet::TCPAppBase::close ( )

protectedvirtual

Referenced by inet::TelnetApp::handleOperationStage(), inet::TCPBasicClientApp::handleOperationStage(), inet::TCPSessionApp::handleOperationStage(), inet::TelnetApp::handleTimer(), inet::TCPSessionApp::handleTimer(), inet::TCPBasicClientApp::socketDataArrived(), and socketPeerClosed().

 {
     EV_INFO << "issuing CLOSE command\n";
     socket.close();
     emit(connectSignal, -1L);
 }

void inet::TCPAppBase::connect ( )

protectedvirtual

Referenced by inet::TelnetApp::handleTimer(), inet::TCPBasicClientApp::handleTimer(), and inet::TCPSessionApp::handleTimer().

 {
     // we need a new connId if this is not the first connection
     socket.renewSocket();
 
     // connect
     const char *connectAddress = par("connectAddress");
     int connectPort = par("connectPort");
 
     L3Address destination;
     L3AddressResolver().tryResolve(connectAddress, destination);
     if (destination.isUnspecified()) {
         EV_ERROR << "Connecting to " << connectAddress << " port=" << connectPort << ": cannot resolve destination address\n";
     }
     else {
         EV_INFO << "Connecting to " << connectAddress << "(" << destination << ") port=" << connectPort << endl;
 
         socket.connect(destination, connectPort);
 
         numSessions++;
         emit(connectSignal, 1L);
     }
 }

void inet::TCPAppBase::finish ( )

overrideprotectedvirtual

Reimplemented in inet::PacketDrillApp, and inet::TCPSessionApp.

 {
     std::string modulePath = getFullPath();
 
     EV_INFO << modulePath << ": opened " << numSessions << " sessions\n";
     EV_INFO << modulePath << ": sent " << bytesSent << " bytes in " << packetsSent << " packets\n";
     EV_INFO << modulePath << ": received " << bytesRcvd << " bytes in " << packetsRcvd << " packets\n";
 }

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

overrideprotectedvirtual

Reimplemented in inet::PacketDrillApp.

 {
     if (msg->isSelfMessage())
         handleTimer(msg);
     else
         socket.processMessage(msg);
 }

virtual void inet::TCPAppBase::handleTimer ( cMessage * msg )

protectedpure virtual

Implemented in inet::PacketDrillApp, inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by handleMessage().

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

overrideprotectedvirtual

Reimplemented in inet::PacketDrillApp, inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by inet::TelnetApp::initialize(), inet::TCPBasicClientApp::initialize(), and inet::TCPSessionApp::initialize().

 {
     cSimpleModule::initialize(stage);
 
     if (stage == INITSTAGE_LOCAL) {
         numSessions = numBroken = packetsSent = packetsRcvd = bytesSent = bytesRcvd = 0;
 
         WATCH(numSessions);
         WATCH(numBroken);
         WATCH(packetsSent);
         WATCH(packetsRcvd);
         WATCH(bytesSent);
         WATCH(bytesRcvd);
     }
     else if (stage == INITSTAGE_APPLICATION_LAYER) {
         // parameters
         const char *localAddress = par("localAddress");
         int localPort = par("localPort");
         socket.readDataTransferModePar(*this);
         socket.bind(*localAddress ? L3AddressResolver().resolve(localAddress) : L3Address(), localPort);
 
         socket.setCallbackObject(this);
         socket.setOutputGate(gate("tcpOut"));
     }
 }

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

inlineoverrideprotectedvirtual

Reimplemented in inet::PacketDrillApp, inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

52 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

void inet::TCPAppBase::refreshDisplay ( ) const

overrideprotectedvirtual

Reimplemented in inet::TCPSessionApp.

 {
     getDisplayString().setTagArg("t", 0, TCPSocket::stateName(socket.getState()));
 }

void inet::TCPAppBase::sendPacket ( cPacket * pkt )

protectedvirtual

Referenced by inet::TCPSessionApp::sendData(), inet::TelnetApp::sendGenericAppMsg(), and inet::TCPBasicClientApp::sendRequest().

 {
     int numBytes = msg->getByteLength();
     emit(sentPkSignal, msg);
     socket.send(msg);
 
     packetsSent++;
     bytesSent += numBytes;
 }

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

Reimplemented in inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by inet::TelnetApp::socketClosed(), inet::TCPBasicClientApp::socketClosed(), and inet::TCPSessionApp::socketClosed().

 {
     // *redefine* to start another session etc.
     EV_INFO << "connection closed\n";
 }

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

overrideprotectedvirtual

Implements inet::TCPSocket::CallbackInterface.

Reimplemented in inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by inet::TelnetApp::socketDataArrived(), inet::TCPBasicClientApp::socketDataArrived(), and inet::TCPSessionApp::socketDataArrived().

 {
     // *redefine* to perform or schedule next sending
     packetsRcvd++;
     bytesRcvd += msg->getByteLength();
     emit(rcvdPkSignal, msg);
     delete msg;
 }

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

Reimplemented in inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by inet::TelnetApp::socketEstablished(), inet::TCPBasicClientApp::socketEstablished(), and inet::TCPSessionApp::socketEstablished().

 {
     // *redefine* to perform or schedule first sending
     EV_INFO << "connected\n";
 }

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

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

Reimplemented in inet::TCPSessionApp, inet::TCPBasicClientApp, and inet::TelnetApp.

Referenced by inet::TelnetApp::socketFailure(), inet::TCPBasicClientApp::socketFailure(), and inet::TCPSessionApp::socketFailure().

 {
     // subclasses may override this function, and add code try to reconnect after a delay.
     EV_WARN << "connection broken\n";
     numBroken++;
 }

void inet::TCPAppBase::socketPeerClosed	(	int	connId,
		void *	yourPtr
	)

overrideprotectedvirtual

Reimplemented from inet::TCPSocket::CallbackInterface.

 {
     // close the connection (if not already closed)
     if (socket.getState() == TCPSocket::PEER_CLOSED) {
         EV_INFO << "remote TCP closed, closing here as well\n";
         close();
     }
 }