inet::TcpBasicClientApp Class Reference

An example request-reply based client application. More...

#include <TcpBasicClientApp.h>

Inheritance diagram for inet::TcpBasicClientApp:

Public Member Functions
	TcpBasicClientApp ()
virtual	~TcpBasicClientApp ()
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 void	sendRequest ()
virtual void	rescheduleAfterOrDeleteTimer (simtime_t d, short int msgKind)
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	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) override
virtual void	close () 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	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
bool	earlySend = false
int	numRequestsToSend = 0
simtime_t	startTime
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 request-reply based client application.

Constructor & Destructor Documentation

TcpBasicClientApp()

inet::TcpBasicClientApp::TcpBasicClientApp ( )

inline

{}

~TcpBasicClientApp()

inet::TcpBasicClientApp::~TcpBasicClientApp ( )

virtual

{
    cancelAndDelete(timeoutMsg);
}

Member Function Documentation

close()

void inet::TcpBasicClientApp::close ( )

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::close();
    cancelEvent(timeoutMsg);
}

Referenced by handleStopOperation(), and socketDataArrived().

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

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

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    simtime_t now = simTime();
    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::TcpBasicClientApp::handleStopOperation ( LifecycleOperation *  operation )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelEvent(timeoutMsg);
    if (socket.getState() == TcpSocket::CONNECTED || socket.getState() == TcpSocket::CONNECTING || socket.getState() == TcpSocket::PEER_CLOSED)
        close();
}

handleTimer()

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

overrideprotectedvirtual

Implements inet::TcpAppBase.

{
    switch (msg->getKind()) {
        case MSGKIND_CONNECT:
            connect(); // active OPEN
 
            // significance of earlySend: if true, data will be sent already
            // in the ACK of SYN, otherwise only in a separate packet (but still
            // immediately)
            if (earlySend)
                sendRequest();
            break;
 
        case MSGKIND_SEND:
            sendRequest();
            numRequestsToSend--;
            // no scheduleAt(): next request will be sent when reply to this one
            // arrives (see socketDataArrived())
            break;
 
        default:
            throw cRuntimeError("Invalid timer msg: kind=%d", msg->getKind());
    }
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        numRequestsToSend = 0;
        earlySend = false; // TODO make it parameter
        WATCH(numRequestsToSend);
        WATCH(earlySend);
 
        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::TcpBasicClientApp::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{ return NUM_INIT_STAGES; }

rescheduleAfterOrDeleteTimer()

void inet::TcpBasicClientApp::rescheduleAfterOrDeleteTimer ( simtime_t  d, short int  msgKind  )

protectedvirtual

{
    if (stopTime < SIMTIME_ZERO || d < stopTime) {
        timeoutMsg->setKind(msgKind);
        rescheduleAfter(d, timeoutMsg);
    }
    else {
        cancelAndDelete(timeoutMsg);
        timeoutMsg = nullptr;
    }
}

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

sendRequest()

void inet::TcpBasicClientApp::sendRequest ( )

protectedvirtual

{
    long requestLength = par("requestLength");
    long replyLength = par("replyLength");
    if (requestLength < 1)
        requestLength = 1;
    if (replyLength < 1)
        replyLength = 1;
 
    const auto& payload = makeShared<GenericAppMsg>();
    Packet *packet = new Packet("data");
    payload->setChunkLength(B(requestLength));
    payload->setExpectedReplyLength(B(replyLength));
    payload->setServerClose(false);
    payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
    packet->insertAtBack(payload);
 
    EV_INFO << "sending request with " << requestLength << " bytes, expected reply length " << replyLength << " bytes,"
            << "remaining " << numRequestsToSend - 1 << " request\n";
 
    sendPacket(packet);
}

Referenced by handleTimer(), and socketEstablished().

socketClosed()

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

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::socketClosed(socket);
 
    // start another session after a delay
    if (timeoutMsg) {
        simtime_t d = par("idleInterval");
        rescheduleAfterOrDeleteTimer(d, MSGKIND_CONNECT);
    }
}

socketDataArrived()

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

overrideprotectedvirtual

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

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::socketDataArrived(socket, msg, urgent);
 
    if (numRequestsToSend > 0) {
        EV_INFO << "reply arrived\n";
 
        if (timeoutMsg) {
            simtime_t d = par("thinkTime");
            rescheduleAfterOrDeleteTimer(d, MSGKIND_SEND);
        }
    }
    else if (socket->getState() != TcpSocket::LOCALLY_CLOSED) {
        EV_INFO << "reply to last request arrived, closing session\n";
        close();
    }
}

socketEstablished()

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

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::socketEstablished(socket);
 
    // determine number of requests in this session
    numRequestsToSend = par("numRequestsPerSession");
    if (numRequestsToSend < 1)
        numRequestsToSend = 1;
 
    // perform first request if not already done (next one will be sent when reply arrives)
    if (!earlySend)
        sendRequest();
 
    numRequestsToSend--;
}

socketFailure()

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

overrideprotectedvirtual

Reimplemented from inet::TcpAppBase.

{
    TcpAppBase::socketFailure(socket, code);
 
    // reconnect after a delay
    if (timeoutMsg) {
        simtime_t d = par("reconnectInterval");
        rescheduleAfterOrDeleteTimer(d, MSGKIND_CONNECT);
    }
}

Member Data Documentation

earlySend

bool inet::TcpBasicClientApp::earlySend = false

protected

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

numRequestsToSend

int inet::TcpBasicClientApp::numRequestsToSend = 0

protected

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

startTime

simtime_t inet::TcpBasicClientApp::startTime

protected

Referenced by handleStartOperation(), and initialize().

stopTime

simtime_t inet::TcpBasicClientApp::stopTime

protected

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

timeoutMsg

cMessage* inet::TcpBasicClientApp::timeoutMsg = nullptr

protected

Referenced by close(), handleCrashOperation(), handleStartOperation(), handleStopOperation(), initialize(), rescheduleAfterOrDeleteTimer(), socketClosed(), socketDataArrived(), socketFailure(), and ~TcpBasicClientApp().

---

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

• TcpBasicClientApp.h
• TcpBasicClientApp.cc