Flooding

Package: inet.networklayer.flooding

Flooding

simple module

C++ definition

A simple flooding protocol for network-level broadcast.

This implementation uses plain flooding, i.e. it "remembers" (stores) already broadcasted messages in a list and does not rebroadcast them again if it gets another copy of that message.

The maximum number of entries for that list can be defined in the .ini file (bcMaxEntries parameter) as well as the time after which an entry is deleted (bcDelTime parameter).

If you prefer a memory-less version, you should set the plainFlooding bool parameter to false.

<b>Author:</b> Daniel Willkomm

ported to Mixim 2.0 by Theodoros Kapourniotis

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.

Extends

Name Type Description
NetworkProtocolBase simple module

Module base for different network protocols.

Parameters

Name Type Default value Description
displayStringTextFormat string ""

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

interfaceTableModule string
headerLength int 96b

Length of the network packet header (in bits)

plainFlooding bool true

Flag whether to use plain flooding

bcMaxEntries int 100

Max number of entries in the list of already broadcasted messages

bcDelTime double 100 s

Time after which an entry for an already broadcasted msg can be deleted

defaultTtl int 10

Default time-to-live (ttl) used for this module expressed in number of hops.

Properties

Name Value Description
class Flooding
display i=block/fork

Gates

Name Direction Size Description
transportIn input
transportOut output
queueIn input
queueOut output

Signals

Name Type Unit Description
packetReceivedFromUpper cPacket
packetReceivedFromLower cPacket
packetDropped cPacket
packetSentToLower cPacket
packetSentToUpper cPacket

Source code

//
// A simple flooding protocol for network-level broadcast.
//
// This implementation uses plain flooding, i.e. it "remembers"
// (stores) already broadcasted messages in a list and does not
// rebroadcast them again if it gets another copy of that message.
//
// The maximum number of entries for that list can be defined in the
// .ini file (`bcMaxEntries` parameter) as well as the time after which an entry
// is deleted (`bcDelTime` parameter).
//
// If you prefer a memory-less version, you should set the `plainFlooding` bool parameter to false.
//
// @author Daniel Willkomm
//
// ported to Mixim 2.0 by Theodoros Kapourniotis
//
simple Flooding extends NetworkProtocolBase like INetworkProtocol
{
    parameters:
        @display("i=block/fork");
        int headerLength @unit(b) = default(96b); // Length of the network packet header (in bits)
        bool plainFlooding = default(true); // Flag whether to use plain flooding
        // Max number of entries in the list of already broadcasted messages
        int bcMaxEntries = default(100);
        // Time after which an entry for an already broadcasted msg can be deleted
        double bcDelTime @unit(s) = default(100 s);
        int defaultTtl = default(10); // Default time-to-live (ttl) used for this module expressed in number of hops.
        @class(Flooding);
}
File: src/inet/networklayer/flooding/Flooding.ned