inet::EtherAppClient Class Reference

Simple traffic generator for the Ethernet model. More...

#include <EtherAppClient.h>

Inheritance diagram for inet::EtherAppClient:

Public Member Functions
	EtherAppClient ()
virtual	~EtherAppClient ()
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::Ieee8022LlcSocket::ICallback
virtual	~ICallback ()

Protected Types
enum	Kinds { START = 100, NEXT }
Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleMessageWhenUp (cMessage *msg) override
virtual void	finish () override
virtual bool	isGenerator ()
virtual void	scheduleNextPacket (bool start)
virtual void	cancelNextPacket ()
virtual MacAddress	resolveDestMacAddress ()
virtual void	sendPacket ()
virtual void	socketDataArrived (Ieee8022LlcSocket *, Packet *msg) override
virtual void	socketClosed (Ieee8022LlcSocket *socket) override
virtual void	handleStartOperation (LifecycleOperation *operation) override
virtual void	handleStopOperation (LifecycleOperation *operation) override
virtual void	handleCrashOperation (LifecycleOperation *operation) 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
long	seqNum = 0
cPar *	reqLength = nullptr
cPar *	respLength = nullptr
cPar *	sendInterval = nullptr
int	localSap = -1
int	remoteSap = -1
MacAddress	destMacAddress
ModuleRefByPar< IInterfaceTable >	interfaceTable
cMessage *	timerMsg = nullptr
simtime_t	startTime
simtime_t	stopTime
Ieee8022LlcSocket	llcSocket
long	packetsSent = 0
long	packetsReceived = 0
Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState
simtime_t	lastChange
Operation	activeOperation
cMessage *	activeOperationTimeout
cMessage *	activeOperationExtraTimer

Detailed Description

Simple traffic generator for the Ethernet model.

Member Enumeration Documentation

Kinds

enum inet::EtherAppClient::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

EtherAppClient()

inet::EtherAppClient::EtherAppClient ( )

inline

{}

~EtherAppClient()

inet::EtherAppClient::~EtherAppClient ( )

virtual

{
    cancelAndDelete(timerMsg);
}

Member Function Documentation

cancelNextPacket()

void inet::EtherAppClient::cancelNextPacket ( )

protectedvirtual

{
    if (timerMsg)
        cancelEvent(timerMsg);
}

Referenced by handleCrashOperation(), and handleStopOperation().

finish()

void inet::EtherAppClient::finish ( )

overrideprotectedvirtual

{
    cancelAndDelete(timerMsg);
    timerMsg = nullptr;
}

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
    if (operation->getRootModule() != getContainingNode(this))
        llcSocket.destroy();
}

handleMessageWhenUp()

void inet::EtherAppClient::handleMessageWhenUp ( cMessage *  msg )

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg->isSelfMessage()) {
        if (msg->getKind() == START) {
            EV_DEBUG << getFullPath() << " registering DSAP " << localSap << "\n";
            int interfaceId = CHK(interfaceTable->findInterfaceByName(par("interface")))->getInterfaceId();
            llcSocket.open(interfaceId, localSap, -1);
 
            destMacAddress = resolveDestMacAddress();
            // if no dest address given, nothing to do
            if (destMacAddress.isUnspecified())
                return;
        }
        sendPacket();
        scheduleNextPacket(false);
    }
    else
        llcSocket.processMessage(msg);
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (isGenerator())
        scheduleNextPacket(true);
}

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
    llcSocket.close();
    delayActiveOperationFinish(par("stopOperationTimeout"));
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    if (stage == INITSTAGE_APPLICATION_LAYER && isGenerator())
        timerMsg = new cMessage("generateNextPacket");
 
    ApplicationBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        reqLength = &par("reqLength");
        respLength = &par("respLength");
        sendInterval = &par("sendInterval");
        interfaceTable.reference(this, "interfaceTableModule", true);
 
        localSap = par("localSAP");
        remoteSap = par("remoteSAP");
 
        seqNum = 0;
        WATCH(seqNum);
 
        // statistics
        packetsSent = packetsReceived = 0;
        WATCH(packetsSent);
        WATCH(packetsReceived);
 
        startTime = par("startTime");
        stopTime = par("stopTime");
        if (stopTime >= SIMTIME_ZERO && stopTime < startTime)
            throw cRuntimeError("Invalid startTime/stopTime parameters");
        llcSocket.setOutputGate(gate("out"));
        llcSocket.setCallback(this);
    }
}

isGenerator()

bool inet::EtherAppClient::isGenerator ( )

protectedvirtual

{
    return par("destAddress").stringValue()[0];
}

Referenced by handleStartOperation(), and initialize().

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

resolveDestMacAddress()

MacAddress inet::EtherAppClient::resolveDestMacAddress ( )

protectedvirtual

{
    MacAddress destMacAddress;
    const char *destAddress = par("destAddress");
    if (destAddress[0]) {
        if (!destMacAddress.tryParse(destAddress))
            destMacAddress = L3AddressResolver().resolve(destAddress, L3AddressResolver::ADDR_MAC).toMac();
    }
    return destMacAddress;
}

Referenced by handleMessageWhenUp().

scheduleNextPacket()

void inet::EtherAppClient::scheduleNextPacket ( bool  start )

protectedvirtual

{
    simtime_t cur = simTime();
    simtime_t next;
    if (start) {
        next = cur <= startTime ? startTime : cur;
        timerMsg->setKind(START);
    }
    else {
        next = cur + *sendInterval;
        timerMsg->setKind(NEXT);
    }
    if (stopTime < SIMTIME_ZERO || next < stopTime)
        scheduleAt(next, timerMsg);
}

Referenced by handleMessageWhenUp(), and handleStartOperation().

sendPacket()

void inet::EtherAppClient::sendPacket ( )

protectedvirtual

{
    seqNum++;
 
    char msgname[30];
    sprintf(msgname, "req-%d-%ld", getId(), seqNum);
    EV_INFO << "Generating packet `" << msgname << "'\n";
 
    Packet *datapacket = new Packet(msgname);
    const auto& data = makeShared<EtherAppReq>();
 
    long len = *reqLength;
    data->setChunkLength(B(len));
    data->setRequestId(seqNum);
 
    long respLen = *respLength;
    data->setResponseBytes(respLen);
 
    data->addTag<CreationTimeTag>()->setCreationTime(simTime());
 
    datapacket->insertAtBack(data);
 
    datapacket->addTag<MacAddressReq>()->setDestAddress(destMacAddress);
    auto ieee802SapReq = datapacket->addTag<Ieee802SapReq>();
    ieee802SapReq->setSsap(localSap);
    ieee802SapReq->setDsap(remoteSap);
 
    emit(packetSentSignal, datapacket);
    llcSocket.send(datapacket);
    packetsSent++;
}

Referenced by handleMessageWhenUp().

socketClosed()

void inet::EtherAppClient::socketClosed ( inet::Ieee8022LlcSocket *  socket )

overrideprotectedvirtual

Implements inet::Ieee8022LlcSocket::ICallback.

{
    if (operationalState == State::STOPPING_OPERATION && !llcSocket.isOpen())
        startActiveOperationExtraTimeOrFinish(par("stopOperationExtraTime"));
}

socketDataArrived()

void inet::EtherAppClient::socketDataArrived ( Ieee8022LlcSocket *  , Packet *  msg  )

overrideprotectedvirtual

Implements inet::Ieee8022LlcSocket::ICallback.

{
    EV_INFO << "Received packet `" << msg->getName() << "'\n";
 
    packetsReceived++;
    emit(packetReceivedSignal, msg);
    delete msg;
}

Member Data Documentation

destMacAddress

MacAddress inet::EtherAppClient::destMacAddress

protected

Referenced by handleMessageWhenUp(), resolveDestMacAddress(), and sendPacket().

interfaceTable

ModuleRefByPar<IInterfaceTable> inet::EtherAppClient::interfaceTable

protected

Referenced by handleMessageWhenUp(), and initialize().

llcSocket

Ieee8022LlcSocket inet::EtherAppClient::llcSocket

protected

Referenced by handleCrashOperation(), handleMessageWhenUp(), handleStopOperation(), initialize(), sendPacket(), and socketClosed().

localSap

int inet::EtherAppClient::localSap = -1

protected

Referenced by handleMessageWhenUp(), initialize(), and sendPacket().

packetsReceived

long inet::EtherAppClient::packetsReceived = 0

protected

Referenced by initialize(), and socketDataArrived().

packetsSent

long inet::EtherAppClient::packetsSent = 0

protected

Referenced by initialize(), and sendPacket().

remoteSap

int inet::EtherAppClient::remoteSap = -1

protected

Referenced by initialize(), and sendPacket().

reqLength

cPar* inet::EtherAppClient::reqLength = nullptr

protected

Referenced by initialize(), and sendPacket().

respLength

cPar* inet::EtherAppClient::respLength = nullptr

protected

Referenced by initialize(), and sendPacket().

sendInterval

cPar* inet::EtherAppClient::sendInterval = nullptr

protected

Referenced by initialize(), and scheduleNextPacket().

seqNum

long inet::EtherAppClient::seqNum = 0

protected

Referenced by initialize(), and sendPacket().

startTime

simtime_t inet::EtherAppClient::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

stopTime

simtime_t inet::EtherAppClient::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

timerMsg

cMessage* inet::EtherAppClient::timerMsg = nullptr

protected

Referenced by cancelNextPacket(), finish(), initialize(), scheduleNextPacket(), and ~EtherAppClient().

---

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

• EtherAppClient.h
• EtherAppClient.cc