This class extends ProbabilisticBroadcast by adding an algorithm which adapts broadcasting parameters according to network conditions. More...

#include <AdaptiveProbabilisticBroadcast.h>

Inheritance diagram for inet::AdaptiveProbabilisticBroadcast:

Public Member Functions
	AdaptiveProbabilisticBroadcast ()

virtual void	initialize (int) override
	Initialization of the module and some variables. More...

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

virtual int	numInitStages () const override
	Initialization of the module and some variables. More...

virtual void	finish () override

const Protocol &	getProtocol () const override

Public Member Functions inherited from inet::NetworkProtocolBase
virtual void	handleRegisterService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

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::DefaultProtocolRegistrationListener
virtual void	handleRegisterServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyService (cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) override

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

Protected Types
typedef std::map< L3Address, cMessage * >	NeighborMap

Protected Types inherited from inet::ProbabilisticBroadcast
enum	messagesTypes { UNKNOWN = 0, BROADCAST_TIMER, NEIGHBOR_TIMER, BETA_TIMER }

typedef struct inet::ProbabilisticBroadcast::tMsgDesc	tMsgDesc
	Store messages in a structure so that we can keep some information needed by the protocol. More...

typedef std::set< unsigned int >	MsgIdSet

typedef std::multimap< simtime_t, tMsgDesc * >	TimeMsgMap

Protected Types inherited from inet::OperationalMixin< cSimpleModule >
enum	State

Protected Member Functions
virtual void	handleLowerPacket (Packet *packet) override
	Handle messages from lower layer. More...

virtual void	handleSelfMessage (cMessage *msg) override
	Handle self messages. More...

void	updateNeighMap (const ProbabilisticBroadcastHeader *m)

void	updateBeta ()

Protected Member Functions inherited from inet::ProbabilisticBroadcast
virtual void	handleUpperPacket (Packet *packet) override
	Handle messages from upper layer. More...

virtual bool	messageKnown (unsigned int msgId)
	Checks whether a message is known (= kept in memory) or not. More...

virtual bool	debugMessageKnown (unsigned int msgId)
	Checks whether a message is known (= kept in memory) or not. More...

virtual void	insertMessage (simtime_t_cref bcastDelay, tMsgDesc *msgDesc)
	Insert a message in both known ID list and message queue. More...

virtual tMsgDesc *	popFirstMessageUpdateQueue (void)
	Returns the descriptor of the first message in the queue, then remove its pointer from the queue and its id from the known IDs list. More...

virtual void	encapsulate (Packet *packet)
	Returns a network layer packet which encapsulates the upper layer packet passed to the function. More...

virtual void	decapsulate (Packet *packet)
	extracts and returns the application layer packet which is encapsulated in the network layer packet given in argument, delete network layer packet. More...

virtual void	insertNewMessage (Packet *packet, bool iAmInitialSender=false)
	Insert a new message in both known ID list and message queue. More...

virtual void	setDownControlInfo (Packet *const pMsg, const MacAddress &pDestAddr)
	Attaches a "control info" (NetwToMac) structure (object) to the message pMsg. More...

virtual void	handleStartOperation (LifecycleOperation *operation) override

virtual void	handleStopOperation (LifecycleOperation *operation) override

virtual void	handleCrashOperation (LifecycleOperation *operation) override

Protected Member Functions inherited from inet::NetworkProtocolBase
	NetworkProtocolBase ()

virtual	~NetworkProtocolBase ()

virtual void	sendUp (cMessage *message)

virtual void	sendDown (cMessage *message, int interfaceId=-1)

virtual bool	isUpperMessage (cMessage *message) const override

virtual bool	isLowerMessage (cMessage *message) const override

virtual bool	isInitializeStage (int stage) const override

virtual bool	isModuleStartStage (int stage) const override

virtual bool	isModuleStopStage (int stage) const override

virtual void	handleUpperCommand (cMessage *msg) override

Protected Member Functions inherited from inet::LayeredProtocolBase
virtual void	handleMessageWhenUp (cMessage *message) override

virtual void	handleUpperMessage (cMessage *message)

virtual void	handleLowerMessage (cMessage *message)

virtual void	handleLowerCommand (cMessage *message)

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
simtime_t	timeInNeighboursTable
	Default ttl for NeighborTable entries in seconds. More...

cOutVector	bvec

NeighborMap	neighMap

Protected Attributes inherited from inet::ProbabilisticBroadcast
simtime_t	broadcastPeriod
	Period (in sim time) between two broadcast attempts. More...

double	beta = 0.0
	Probability of each broadcast attempt. More...

simtime_t	timeToLive

int	maxNbBcast = 0
	Maximal number of broadcast attempts for each packet. More...

simtime_t	maxFirstBcastBackoff
	Maximal back-off before first broadcast attempt [seconds]. More...

simtime_t	timeInQueueAfterDeath
	How long the message should be kept in queue after its died. More...

int	headerLength = 0
	Length of the NetwPkt header Read from omnetpp.ini. More...

cMessage *	broadcastTimer = nullptr

MsgIdSet	knownMsgIds

TimeMsgMap	msgQueue

MsgIdSet	debugMsgIdSet

long	nbDataPacketsReceived = 0

long	nbDataPacketsSent = 0

long	nbHops = 0

int	debugNbMessageKnown = 0

long	nbDataPacketsForwarded = 0

cOutVector	oneHopLatencies

L3Address	myNetwAddr

Protected Attributes inherited from inet::NetworkProtocolBase
ModuleRefByPar< IInterfaceTable >	interfaceTable

std::set< const Protocol * >	upperProtocols

std::map< int, SocketDescriptor * >	socketIdToSocketDescriptor

Protected Attributes inherited from inet::OperationalMixin< cSimpleModule >
State	operationalState

simtime_t	lastChange

Operation	activeOperation

cMessage *	activeOperationTimeout

cMessage *	activeOperationExtraTimer

Additional Inherited Members
Static Protected Member Functions inherited from inet::ProbabilisticBroadcast
static long	getNextID ()

Static Protected Attributes inherited from inet::ProbabilisticBroadcast
static long	id_counter = 0

Detailed Description

This class extends ProbabilisticBroadcast by adding an algorithm which adapts broadcasting parameters according to network conditions.

Author: Dimitris Kotsakos, George Alyfantis, Damien Piguet

Member Typedef Documentation

◆ NeighborMap

typedef std::map<L3Address, cMessage *> inet::AdaptiveProbabilisticBroadcast::NeighborMap

protected

Constructor & Destructor Documentation

◆ AdaptiveProbabilisticBroadcast()

inet::AdaptiveProbabilisticBroadcast::AdaptiveProbabilisticBroadcast ( )

inline

29 {}

Member Function Documentation

◆ handleLowerPacket()

void inet::AdaptiveProbabilisticBroadcast::handleLowerPacket ( Packet * packet )

overrideprotectedvirtual

Handle messages from lower layer.

Reimplemented from inet::ProbabilisticBroadcast.

 {
     const auto& macHeader = packet->peekAtFront<ProbabilisticBroadcastHeader>();
     // Update neighbors table before calling the method of the super class
     // because it may delete the message.
     updateNeighMap(macHeader.get());
     ProbabilisticBroadcast::handleLowerPacket(packet);
 }

◆ handleSelfMessage()

void inet::AdaptiveProbabilisticBroadcast::handleSelfMessage ( cMessage * msg )

overrideprotectedvirtual

Handle self messages.

Reimplemented from inet::ProbabilisticBroadcast.

 {
     if (msg->getKind() == NEIGHBOR_TIMER) {
         const NeighborMap::key_type& node = *static_cast<NeighborMap::key_type *>(msg->getContextPointer());
         EV << "handleSelfMsg(): Remove node " << node << " from NeighMap!" << endl;
         auto it = neighMap.find(node);
         ASSERT(it != neighMap.end());
         cancelAndDelete(it->second);
         neighMap.erase(it);
         updateBeta();
     }
     else {
         ProbabilisticBroadcast::handleSelfMessage(msg);
     }
 }

◆ initialize()

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

overridevirtual

Initialization of the module and some variables.

Reimplemented from inet::ProbabilisticBroadcast.

 {
     ProbabilisticBroadcast::initialize(stage);
  
     if (stage == INITSTAGE_LOCAL) {
         beta = 1.0;
  
         bvec.setName("Beta Vector");
  
         timeInNeighboursTable = par("timeInNeighboursTable");
     }
 }

◆ updateBeta()

void inet::AdaptiveProbabilisticBroadcast::updateBeta ( )

protected

 {
     int k = neighMap.size();
  
     // those values are derived from the simulations
     // with the non-adaptive protocol.
     if (k < 4)
         beta = 1.0;
     else if (k < 6)
         beta = 0.9;
     else if (k < 8)
         beta = 0.8;
     else if (k < 10)
         beta = 0.7;
     else if (k < 12)
         beta = 0.6;
     else if (k < 14)
         beta = 0.5;
     else if (k < 16)
         beta = 0.4;
     else if (k < 18)
         beta = 0.3;
     else if (k < 20)
         beta = 0.2;
     else
         beta = 0.1;
     bvec.record(beta);
 }

Referenced by handleSelfMessage(), and updateNeighMap().

◆ updateNeighMap()

void inet::AdaptiveProbabilisticBroadcast::updateNeighMap ( const ProbabilisticBroadcastHeader * m )

protected

 {
     // find the network address of the node who sent the msg
     NeighborMap::key_type nodeAddress = m->getSrcAddr();
 //    EV << "updateNeighMap(): neighAddress: " << nodeAddress << endl;
  
     // search for it in the "already-neighbors" map
     auto it = neighMap.find(nodeAddress);
  
     // if the node is a "new" neighbor
     if (it == neighMap.end()) {
         EV << "updateNeighMap(): The message came from a new neighbor! " << endl;
  
         // insert key value pair <node address, event> in neighborhood map.
         cMessage *removeEvent = new cMessage("removeEvent", NEIGHBOR_TIMER);
  
         // schedule the event to remove the entry after initT seconds
         scheduleAfter(timeInNeighboursTable, removeEvent);
  
         NeighborMap::value_type pairToInsert = make_pair(nodeAddress, removeEvent);
         pair<NeighborMap::iterator, bool> ret = neighMap.insert(pairToInsert);
  
         // set the context pointer to point to the integer that resembles to the address of
         // the node to be removed when the corresponding event occurs
         (ret.first)->second->setContextPointer((void *)(&(ret.first)->first));
     }
     // if the node is NOT a "new" neighbor update its timer
     else {
         EV << "updateNeighMap(): The message came from an already known neighbor! " << endl;
         // Cancel the event that was scheduled to remove the entry for this neighbor.
         // Define a new event in order to remove the entry after initT seconds
         // Set the context pointer to point to the integer that resembles to the address of
         // the node to be removed when the corresponding event occurs
         it->second->setContextPointer((void *)(&it->first));
         rescheduleAfter(timeInNeighboursTable, it->second);
     }
     updateBeta();
 }

Referenced by handleLowerPacket().

Member Data Documentation

◆ bvec

cOutVector inet::AdaptiveProbabilisticBroadcast::bvec

protected

Referenced by initialize(), and updateBeta().

◆ neighMap

NeighborMap inet::AdaptiveProbabilisticBroadcast::neighMap

protected

Referenced by handleSelfMessage(), updateBeta(), and updateNeighMap().

◆ timeInNeighboursTable

simtime_t inet::AdaptiveProbabilisticBroadcast::timeInNeighboursTable

protected

Default ttl for NeighborTable entries in seconds.

Referenced by initialize(), and updateNeighMap().

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

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ NeighborMap

Constructor & Destructor Documentation

◆ AdaptiveProbabilisticBroadcast()

Member Function Documentation

◆ handleLowerPacket()

◆ handleSelfMessage()

◆ initialize()

◆ updateBeta()

◆ updateNeighMap()

Member Data Documentation

◆ bvec

◆ neighMap

◆ timeInNeighboursTable