inet::EtherTrafGen Class Reference

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

#include <EtherTrafGen.h>

Inheritance diagram for inet::EtherTrafGen:

Public Member Functions
	EtherTrafGen ()
virtual	~EtherTrafGen ()
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 ()

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 (simtime_t previous)
virtual void	cancelNextPacket ()
virtual MacAddress	resolveDestMacAddress ()
virtual void	sendBurstPackets ()
virtual void	receivePacket (Packet *msg)
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
ModuleRefByPar< IInterfaceTable >	interfaceTable
long	seqNum = 0
cPar *	sendInterval = nullptr
cPar *	numPacketsPerBurst = nullptr
cPar *	packetLength = nullptr
int	ssap = -1
int	dsap = -1
MacAddress	destMacAddress
int	outInterface = -1
Ieee8022LlcSocket	llcSocket
cMessage *	timerMsg = nullptr
simtime_t	startTime
simtime_t	stopTime
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::EtherTrafGen::Kinds

protected

Enumerator
START
NEXT

{ START = 100, NEXT };

Constructor & Destructor Documentation

EtherTrafGen()

inet::EtherTrafGen::EtherTrafGen

(

)

{
    sendInterval = nullptr;
    numPacketsPerBurst = nullptr;
    packetLength = nullptr;
    timerMsg = nullptr;
}

~EtherTrafGen()

inet::EtherTrafGen::~EtherTrafGen ( )

virtual

{
    cancelAndDelete(timerMsg);
}

Member Function Documentation

cancelNextPacket()

void inet::EtherTrafGen::cancelNextPacket ( )

protectedvirtual

{
    cancelEvent(timerMsg);
}

Referenced by handleCrashOperation(), and handleStopOperation().

finish()

void inet::EtherTrafGen::finish ( )

overrideprotectedvirtual

{
    cancelAndDelete(timerMsg);
    timerMsg = nullptr;
}

handleCrashOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
    if (operation->getRootModule() != getContainingNode(this)) // closes socket when the application crashed only
        llcSocket.destroy(); // TODO  in real operating systems, program crash detected by OS and OS closes sockets of crashed programs.
}

handleMessageWhenUp()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (msg->isSelfMessage()) {
        if (msg->getKind() == START) {
            llcSocket.open(-1, ssap, -1);
            destMacAddress = resolveDestMacAddress();
            // if no dest address given, nothing to do
            if (destMacAddress.isUnspecified())
                return;
        }
        sendBurstPackets();
        scheduleNextPacket(simTime());
    }
    else
        receivePacket(check_and_cast<Packet *>(msg));
}

handleStartOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    if (isGenerator()) {
        scheduleNextPacket(-1);
    }
}

handleStopOperation()

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

overrideprotectedvirtual

Implements inet::OperationalMixin< cSimpleModule >.

{
    cancelNextPacket();
    llcSocket.close(); // TODO return false and waiting socket close
}

initialize()

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

overrideprotectedvirtual

Reimplemented from inet::OperationalMixin< cSimpleModule >.

{
    if (stage == INITSTAGE_APPLICATION_LAYER && isGenerator()) {
        timerMsg = new cMessage("generateNextPacket");
        outInterface = CHK(interfaceTable->findInterfaceByName(par("interface")))->getInterfaceId();
    }
 
    ApplicationBase::initialize(stage);
 
    if (stage == INITSTAGE_LOCAL) {
        interfaceTable.reference(this, "interfaceTableModule", true);
        sendInterval = &par("sendInterval");
        numPacketsPerBurst = &par("numPacketsPerBurst");
        packetLength = &par("packetLength");
        ssap = par("ssap");
        dsap = par("dsap");
 
        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"));
    }
}

isGenerator()

bool inet::EtherTrafGen::isGenerator ( )

protectedvirtual

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

Referenced by handleStartOperation(), and initialize().

numInitStages()

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

receivePacket()

void inet::EtherTrafGen::receivePacket ( Packet *  msg )

protectedvirtual

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

Referenced by handleMessageWhenUp().

resolveDestMacAddress()

MacAddress inet::EtherTrafGen::resolveDestMacAddress ( )

protectedvirtual

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

Referenced by handleMessageWhenUp().

scheduleNextPacket()

void inet::EtherTrafGen::scheduleNextPacket ( simtime_t  previous )

protectedvirtual

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

Referenced by handleMessageWhenUp(), and handleStartOperation().

sendBurstPackets()

void inet::EtherTrafGen::sendBurstPackets ( )

protectedvirtual

{
    int n = *numPacketsPerBurst;
    for (int i = 0; i < n; i++) {
        seqNum++;
 
        char msgname[40];
        sprintf(msgname, "pk-%d-%ld", getId(), seqNum);
 
        Packet *datapacket = new Packet(msgname, SOCKET_C_DATA);
        long len = *packetLength;
        const auto& payload = makeShared<ByteCountChunk>(B(len));
        payload->addTag<CreationTimeTag>()->setCreationTime(simTime());
        datapacket->insertAtBack(payload);
        datapacket->addTag<DispatchProtocolReq>()->setProtocol(&Protocol::ieee8022llc);
        datapacket->addTag<MacAddressReq>()->setDestAddress(destMacAddress);
        datapacket->addTag<InterfaceReq>()->setInterfaceId(outInterface);
        auto sapTag = datapacket->addTag<Ieee802SapReq>();
        sapTag->setSsap(ssap);
        sapTag->setDsap(dsap);
 
        EV_INFO << "Send packet `" << msgname << "' dest=" << destMacAddress << " length=" << len << "B ssap/dsap=" << ssap << "/" << dsap << "\n";
        emit(packetSentSignal, datapacket);
        send(datapacket, "out");
        packetsSent++;
    }
}

Referenced by handleMessageWhenUp().

Member Data Documentation

destMacAddress

MacAddress inet::EtherTrafGen::destMacAddress

protected

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

dsap

int inet::EtherTrafGen::dsap = -1

protected

Referenced by initialize(), and sendBurstPackets().

interfaceTable

ModuleRefByPar<IInterfaceTable> inet::EtherTrafGen::interfaceTable

protected

Referenced by initialize().

llcSocket

Ieee8022LlcSocket inet::EtherTrafGen::llcSocket

protected

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

numPacketsPerBurst

cPar* inet::EtherTrafGen::numPacketsPerBurst = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and sendBurstPackets().

outInterface

int inet::EtherTrafGen::outInterface = -1

protected

Referenced by initialize(), and sendBurstPackets().

packetLength

cPar* inet::EtherTrafGen::packetLength = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and sendBurstPackets().

packetsReceived

long inet::EtherTrafGen::packetsReceived = 0

protected

Referenced by initialize(), and receivePacket().

packetsSent

long inet::EtherTrafGen::packetsSent = 0

protected

Referenced by initialize(), and sendBurstPackets().

sendInterval

cPar* inet::EtherTrafGen::sendInterval = nullptr

protected

Referenced by EtherTrafGen(), initialize(), and scheduleNextPacket().

seqNum

long inet::EtherTrafGen::seqNum = 0

protected

Referenced by initialize(), and sendBurstPackets().

ssap

int inet::EtherTrafGen::ssap = -1

protected

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

startTime

simtime_t inet::EtherTrafGen::startTime

protected

Referenced by initialize(), and scheduleNextPacket().

stopTime

simtime_t inet::EtherTrafGen::stopTime

protected

Referenced by initialize(), and scheduleNextPacket().

timerMsg

cMessage* inet::EtherTrafGen::timerMsg = nullptr

protected

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

---

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

• EtherTrafGen.h
• EtherTrafGen.cc