Implements an interface that corresponds to a real interface on the host running the simulation. More...

#include <ExtInterface.h>

Inheritance diagram for inet::ExtInterface:

Public Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual void	handleMessage (cMessage *msg) override

virtual void	finish () override

Public Member Functions inherited from inet::MACBase
	MACBase ()

virtual	~MACBase ()

Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
void	displayBusy ()

void	displayIdle ()

virtual void	refreshDisplay () const override

InterfaceEntry *	createInterfaceEntry () override
	should create InterfaceEntry More...

virtual void	flushQueue () override
	should clear queue and emit signal "dropPkFromHLIfaceDown" with entire packets More...

virtual void	clearQueue () override
	should clear queue silently More...

virtual bool	isUpperMsg (cMessage *msg) override
	should return true if the msg arrived from upper layer, else return false More...

Protected Member Functions inherited from inet::MACBase
void	registerInterface ()

virtual void	receiveSignal (cComponent source, simsignal_t signalID, cObject obj, cObject *details) override

virtual bool	handleOperationStage (LifecycleOperation operation, int stage, IDoneCallback doneCallback) override
	Perform one stage of a lifecycle operation. More...

virtual void	updateOperationalFlag (bool isNodeUp)

virtual bool	isNodeUp ()

virtual void	handleMessageWhenDown (cMessage *msg)

Protected Attributes
bool	connected

uint8	buffer [1<< 16]

const char *	device

int	numSent

int	numRcvd

int	numDropped

cSocketRTScheduler *	rtScheduler

Protected Attributes inherited from inet::MACBase
cModule *	hostModule = nullptr

bool	isOperational = false

InterfaceEntry *	interfaceEntry = nullptr

Detailed Description

Implements an interface that corresponds to a real interface on the host running the simulation.

Suitable for hardware-in-the-loop simulations.

Requires cSocketRTScheduler to be configured as scheduler in omnetpp.ini.

See NED file for more details.

Member Function Documentation

void inet::ExtInterface::clearQueue ( )

overrideprotectedvirtual

should clear queue silently

Implements inet::MACBase.

 {
     // does not have a queue, do nothing
 }

InterfaceEntry * inet::ExtInterface::createInterfaceEntry ( )

overrideprotectedvirtual

should create InterfaceEntry

Implements inet::MACBase.

 {
     InterfaceEntry *e = new InterfaceEntry(this);
 
     e->setMtu(par("mtu"));
     e->setMulticast(true);
     e->setPointToPoint(true);
 
     return e;
 }

void inet::ExtInterface::displayBusy ( )

protected

 {
     getDisplayString().setTagArg("i", 1, "yellow");
     gate("physOut")->getDisplayString().setTagArg("ls", 0, "yellow");
     gate("physOut")->getDisplayString().setTagArg("ls", 1, "3");
 }

void inet::ExtInterface::displayIdle ( )

protected

 {
     getDisplayString().setTagArg("i", 1, "");
     gate("physOut")->getDisplayString().setTagArg("ls", 0, "black");
     gate("physOut")->getDisplayString().setTagArg("ls", 1, "1");
 }

void inet::ExtInterface::finish ( )

overridevirtual

 {
     std::cout << getFullPath() << ": " << numSent << " packets sent, "
               << numRcvd << " packets received, " << numDropped << " packets dropped.\n";
 }

void inet::ExtInterface::flushQueue ( )

overrideprotectedvirtual

should clear queue and emit signal "dropPkFromHLIfaceDown" with entire packets

Implements inet::MACBase.

 {
     // does not have a queue, do nothing
 }

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

overridevirtual

 {
     using namespace serializer;
 
     if (!isOperational) {
         handleMessageWhenDown(msg);
         return;
     }
 
     if (dynamic_cast<ExtFrame *>(msg) != nullptr) {
         // incoming real packet from wire (captured by pcap)
         uint32 packetLength;
         ExtFrame *rawPacket = check_and_cast<ExtFrame *>(msg);
 
         packetLength = rawPacket->getDataArraySize();
         for (uint32 i = 0; i < packetLength; i++)
             buffer[i] = rawPacket->getData(i);
 
         Buffer b(const_cast<unsigned char *>(buffer), packetLength);
         Context c;
         IPv4Datagram *ipPacket = check_and_cast<IPv4Datagram *>(IPv4Serializer().deserializePacket(b, c));
         EV << "Delivering an IPv4 packet from "
            << ipPacket->getSrcAddress()
            << " to "
            << ipPacket->getDestAddress()
            << " and length of"
            << ipPacket->getByteLength()
            << " bytes to IPv4 layer.\n";
         send(ipPacket, "upperLayerOut");
         numRcvd++;
     }
     else {
         memset(buffer, 0, sizeof(buffer));
         IPv4Datagram *ipPacket = check_and_cast<IPv4Datagram *>(msg);
 
         if (connected) {
             struct sockaddr_in addr;
             addr.sin_family = AF_INET;
 #if !defined(linux) && !defined(__linux) && !defined(_WIN32)
             addr.sin_len = sizeof(struct sockaddr_in);
 #endif // if !defined(linux) && !defined(__linux) && !defined(_WIN32)
             addr.sin_port = 0;
             addr.sin_addr.s_addr = htonl(ipPacket->getDestAddress().getInt());
             Buffer b(const_cast<unsigned char *>(buffer), sizeof(buffer));
             Context c;
             c.throwOnSerializerNotFound = false;
             IPv4Serializer().serializePacket(ipPacket, b, c);
             if (b.hasError() || c.errorOccured) {
                 EV_ERROR << "Cannot serialize and send packet << '" << ipPacket->getName() << "' with protocol " << ipPacket->getTransportProtocol() << ".\n";
                 numDropped++;
                 delete (msg);
                 return;
             }
             int32 packetLength = b.getPos();
             EV << "Delivering an IPv4 packet from "
                << ipPacket->getSrcAddress()
                << " to "
                << ipPacket->getDestAddress()
                << " and length of "
                << ipPacket->getByteLength()
                << " bytes to link layer.\n";
             rtScheduler->sendBytes(buffer, packetLength, (struct sockaddr *)&addr, sizeof(struct sockaddr_in));
             numSent++;
         }
         else {
             EV << "Interface is not connected, dropping packet " << msg << endl;
             numDropped++;
         }
     }
     delete (msg);
 }

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

overridevirtual

Reimplemented from inet::MACBase.

 {
     MACBase::initialize(stage);
 
     // subscribe at scheduler for external messages
     if (stage == INITSTAGE_LOCAL) {
         if (dynamic_cast<cSocketRTScheduler *>(getSimulation()->getScheduler()) != nullptr) {
             rtScheduler = check_and_cast<cSocketRTScheduler *>(getSimulation()->getScheduler());
             //device = getEnvir()->config()->getAsString("Capture", "device", "lo0");
             device = par("device");
             //const char *filter = getEnvir()->config()->getAsString("Capture", "filter-string", "ip");
             const char *filter = par("filterString");
             rtScheduler->setInterfaceModule(this, device, filter);
             connected = true;
         }
         else {
             // this simulation run works without external interface..
             connected = false;
         }
         numSent = numRcvd = numDropped = 0;
         WATCH(numSent);
         WATCH(numRcvd);
         WATCH(numDropped);
     }
     else if (stage == INITSTAGE_LINK_LAYER) {
         registerInterface();
     }
 }

virtual bool inet::ExtInterface::isUpperMsg ( cMessage * msg )

inlineoverrideprotectedvirtual

should return true if the msg arrived from upper layer, else return false

Implements inet::MACBase.

72 { return msg->arrivedOn("upperLayerIn"); }

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

inlineoverridevirtual

Reimplemented from inet::MACBase.

75 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

void inet::ExtInterface::refreshDisplay ( ) const

overrideprotectedvirtual

 {
     const char *str;
 
     if (connected) {
         char buf[80];
         sprintf(buf, "pcap device: %s\nrcv:%d snt:%d", device, numRcvd, numSent);
         str = buf;
         getDisplayString().setTagArg("t", 0, buf);
     }
     else {
         getDisplayString().setTagArg("i", 1, "#707070");
         getDisplayString().setTagArg("i", 2, "100");
         getDisplayString().setTagArg("t", 0, "not connected");
     }
 }