#include <CloudDelayerBase.h>

Inheritance diagram for inet::CloudDelayerBase:

Public Member Functions
	CloudDelayerBase ()

	~CloudDelayerBase ()

Public Member Functions inherited from inet::INetfilter::IHook
virtual	~IHook ()

Protected Member Functions
virtual void	initialize (int stage) override

virtual int	numInitStages () const override

virtual void	finish () override

virtual void	handleMessage (cMessage *msg) override

virtual void	calculateDropAndDelay (const cMessage *msg, int srcID, int destID, bool &outDrop, simtime_t &outDelay)
	Returns true in outDrop if the msg is dropped in cloud, otherwise returns calculated delay in outDelay. More...

virtual INetfilter::IHook::Result	datagramPreRoutingHook (INetworkDatagram datagram, const InterfaceEntry inputInterfaceEntry, const InterfaceEntry *&outputInterfaceEntry, L3Address &nextHopAddress) override
	This is the first hook called by the network protocol before it routes a datagram that was received from the lower layer. More...

virtual INetfilter::IHook::Result	datagramForwardHook (INetworkDatagram datagram, const InterfaceEntry inputInterfaceEntry, const InterfaceEntry *&outputInterfaceEntry, L3Address &nextHopAddress) override
	This is the second hook called by the network protocol before it sends a datagram to the lower layer. More...

virtual INetfilter::IHook::Result	datagramPostRoutingHook (INetworkDatagram datagram, const InterfaceEntry inputInterfaceEntry, const InterfaceEntry *&outputInterfaceEntry, L3Address &nextHopAddress) override
	This is the last hook called by the network protocol before it sends a datagram to the lower layer. More...

virtual INetfilter::IHook::Result	datagramLocalInHook (INetworkDatagram datagram, const InterfaceEntry inputInterfaceEntry) override
	This is the last hook called by the network protocol before it sends a datagram to the upper layer. More...

virtual INetfilter::IHook::Result	datagramLocalOutHook (INetworkDatagram datagram, const InterfaceEntry &outputInterfaceEntry, L3Address &nextHopAddress) override
	This is the first hook called by the network protocol before it routes a datagram that was received from the upper layer. More...

Protected Attributes
IPv4 *	ipv4Layer

Additional Inherited Members
Public Types inherited from inet::INetfilter::IHook
enum	Type { PREROUTING, LOCALIN, FORWARD, POSTROUTING, LOCALOUT }

enum	Result { ACCEPT, DROP, QUEUE, STOLEN }

Constructor & Destructor Documentation

inet::CloudDelayerBase::CloudDelayerBase ( )

 {
     ipv4Layer = nullptr;
 }

inet::CloudDelayerBase::~CloudDelayerBase ( )

 {
     //TODO unregister hook if ipv4Layer exists
     ipv4Layer = check_and_cast_nullable<IPv4 *>(getModuleByPath("^.ip"));
     if (ipv4Layer)
         ipv4Layer->unregisterHook(0, this);
 }

Member Function Documentation

void inet::CloudDelayerBase::calculateDropAndDelay	(	const cMessage *	msg,
		int	srcID,
		int	destID,
		bool &	outDrop,
		simtime_t &	outDelay
	)

protectedvirtual

Returns true in outDrop if the msg is dropped in cloud, otherwise returns calculated delay in outDelay.

Reimplemented in inet::MatrixCloudDelayer.

Referenced by datagramForwardHook().

 {
     outDrop = false;
     outDelay = SIMTIME_ZERO;
 }

INetfilter::IHook::Result inet::CloudDelayerBase::datagramForwardHook	(	INetworkDatagram *	datagram,
		const InterfaceEntry *	inputInterfaceEntry,
		const InterfaceEntry *&	outputInterfaceEntry,
		L3Address &	nextHopAddress
	)

overrideprotectedvirtual

This is the second hook called by the network protocol before it sends a datagram to the lower layer.

This is done after the datagramPreRoutingHook or the datagramLocalInHook is called and the datagram is routed.

Implements inet::INetfilter::IHook.

 {
     Enter_Method_Silent();
 
     int srcID = inputInterfaceEntry ? inputInterfaceEntry->getInterfaceId() : -1;
     int destID = outputInterfaceEntry->getInterfaceId();
 
     cMessage *msg = check_and_cast<cMessage *>(datagram);
     simtime_t propDelay;
     bool isDrop;
     calculateDropAndDelay(msg, srcID, destID, isDrop, propDelay);
     if (isDrop) {
         //TODO emit?
         EV_INFO << "Message " << msg->str() << " dropped in cloud.\n";
         return INetfilter::IHook::DROP;
     }
 
     if (propDelay > SIMTIME_ZERO) {
         //TODO emit?
         EV_INFO << "Message " << msg->str() << " delayed with " << propDelay * 1000.0 << "ms in cloud.\n";
         cMessage *selfmsg = new cMessage("Delay");
         selfmsg->setContextPointer(datagram);
         scheduleAt(simTime() + propDelay, selfmsg);
         return INetfilter::IHook::QUEUE;
     }
     return INetfilter::IHook::ACCEPT;
 }

INetfilter::IHook::Result inet::CloudDelayerBase::datagramLocalInHook	(	INetworkDatagram *	datagram,
		const InterfaceEntry *	inputInterfaceEntry
	)

overrideprotectedvirtual

This is the last hook called by the network protocol before it sends a datagram to the upper layer.

This is done after the datagramPreRoutingHook is called and the datagram is routed.

Implements inet::INetfilter::IHook.

 {
     return INetfilter::IHook::ACCEPT;
 }

INetfilter::IHook::Result inet::CloudDelayerBase::datagramLocalOutHook	(	INetworkDatagram *	datagram,
		const InterfaceEntry *&	outputInterfaceEntry,
		L3Address &	nextHopAddress
	)

overrideprotectedvirtual

This is the first hook called by the network protocol before it routes a datagram that was received from the upper layer.

The nextHopAddress is ignored when the outputInterfaceEntry is a nullptr. After this is done

Implements inet::INetfilter::IHook.

 {
     return INetfilter::IHook::ACCEPT;
 }

INetfilter::IHook::Result inet::CloudDelayerBase::datagramPostRoutingHook	(	INetworkDatagram *	datagram,
		const InterfaceEntry *	inputInterfaceEntry,
		const InterfaceEntry *&	outputInterfaceEntry,
		L3Address &	nextHopAddress
	)

overrideprotectedvirtual

This is the last hook called by the network protocol before it sends a datagram to the lower layer.

Implements inet::INetfilter::IHook.

 {
     return INetfilter::IHook::ACCEPT;
 }

INetfilter::IHook::Result inet::CloudDelayerBase::datagramPreRoutingHook	(	INetworkDatagram *	datagram,
		const InterfaceEntry *	inputInterfaceEntry,
		const InterfaceEntry *&	outputInterfaceEntry,
		L3Address &	nextHopAddress
	)

overrideprotectedvirtual

This is the first hook called by the network protocol before it routes a datagram that was received from the lower layer.

The nextHopAddress is ignored when the outputInterfaceEntry is nullptr.

Implements inet::INetfilter::IHook.

 {
     return INetfilter::IHook::ACCEPT;
 }

void inet::CloudDelayerBase::finish ( )

overrideprotectedvirtual

 {
     if (ipv4Layer)
         ipv4Layer->unregisterHook(0, this);
     ipv4Layer = nullptr;
 }

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

overrideprotectedvirtual

 {
     if (msg->isSelfMessage()) {
         INetworkDatagram *context = (INetworkDatagram *)msg->getContextPointer();
         delete msg;
         ipv4Layer->reinjectQueuedDatagram(context);
     }
 }

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

overrideprotectedvirtual

Reimplemented in inet::MatrixCloudDelayer.

Referenced by inet::MatrixCloudDelayer::initialize().

 {
     cSimpleModule::initialize(stage);
 
     if (stage == INITSTAGE_NETWORK_LAYER) {
         ipv4Layer = check_and_cast<IPv4 *>(getModuleByPath("^.ip"));
         ipv4Layer->registerHook(0, this);
     }
 }

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

inlineoverrideprotectedvirtual

Reimplemented in inet::MatrixCloudDelayer.

40 { return NUM_INIT_STAGES; }

inet::NUM_INIT_STAGES

The number of initialization stages.

Definition: InitStages.h:116

Member Data Documentation

IPv4* inet::CloudDelayerBase::ipv4Layer

protected

Referenced by CloudDelayerBase(), finish(), handleMessage(), initialize(), and ~CloudDelayerBase().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation