Compound Module SimpleMultiOverlayHost

Package: oversim.underlay.simpleunderlay
File: src/underlay/simpleunderlay/SimpleMultiOverlayHost.ned

Host in the simple network that participates in the overlay

Author: Stephan Krause, Bernhard Heep, Ingmar Baumgart

NotificationBoard ITier ITier ITier IOverlay SimpleUDP InterfaceTable NeighborCache CryptoModule BootstrapList

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram:

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

Parameters:

Name Type Default value Description
overlayType string

overlay protocol compound module to use

tier1Type string

tier 1 application to use

tier2Type string

tier 2 module to use

tier3Type string

tier 3 module to use

numTiers int

number of tiers

numOverlayModulesPerNode double

number of parallel overlays

routingFile string ""
IPForward bool false

Properties:

Name Value Description
display bgb=433,386

Gates:

Name Direction Size Description
overlayNeighborArrowIn [ ] input

incoming gate for visualizing overlay neighborship with connection arrows

overlayNeighborArrowOut [ ] output

incoming gate for visualizing overlay neighborship with connection arrows

out output

Dummy gate for storing channel informations

in input

Dummy gate for connecting out

Unassigned submodule parameters:

Name Type Default value Description
udp.constantDelay double

constant delay between two peers

udp.useCoordinateBasedDelay bool

delay should be calculated from euklidean distance between two peers

udp.delayFaultType string

augment coordinate based delays with a realistic error, according to "Network Coordinates in the Wild", Figure 7 possible values: empty, "live_all", "live_planetlab", "simulation"

udp.jitter double

average amount of jitter in %

neighborCache.rpcUdpTimeout double

default timeout value for direct RPCs

neighborCache.rpcKeyTimeout double

default timeout value for routed RPCs

neighborCache.optimizeTimeouts bool

calculate timeouts from measured RTTs and network coordinates

neighborCache.rpcExponentialBackoff bool

if true, doubles the timeout for every retransmission

neighborCache.debugOutput bool

enable debug output

neighborCache.enableNeighborCache bool

use neighbor cache for reducing ping traffic?

neighborCache.rttExpirationTime double

expiration of the validity of the measured rtts

neighborCache.maxSize double

maximum size of the cache

neighborCache.rttHistory int
neighborCache.timeoutAccuracyLimit double
neighborCache.defaultQueryType string
neighborCache.defaultQueryTypeI string
neighborCache.defaultQueryTypeQ string
neighborCache.doDiscovery bool
neighborCache.ncsType string
neighborCache.npsDimensions int

gnp settings

neighborCache.npsCoordCalcRuns int
neighborCache.landmarkTimeout double
neighborCache.npsMaxLayer int

nps settings

neighborCache.showVivaldiPosition bool

vivaldi settings

neighborCache.vivaldiErrorConst double
neighborCache.vivaldiCoordConst double
neighborCache.vivaldiDimConst double
neighborCache.vivaldiEnableHeightVector bool
neighborCache.vivaldiLossConst double

svivaldi settings

neighborCache.lossResetLimit double
cryptoModule.keyFile string

the name of the file containing the public key pair used to sign messages

bootstrapList.rpcUdpTimeout double

default timeout value for direct RPCs

bootstrapList.rpcKeyTimeout double

default timeout value for routed RPCs

bootstrapList.optimizeTimeouts bool

calculate timeouts from measured RTTs and network coordinates

bootstrapList.rpcExponentialBackoff bool

if true, doubles the timeout for every retransmission

bootstrapList.debugOutput bool

enable debug output

bootstrapList.mergeOverlayPartitions bool

if true, detect and merge overlay partitions

bootstrapList.maintainList bool

maintain a list of bootstrap candidates and check them periodically

Source code:

//
// Host in the simple network that participates in the overlay
//
// @author Stephan Krause, Bernhard Heep, Ingmar Baumgart
//
module SimpleMultiOverlayHost
{
    parameters:
        string overlayType; // overlay protocol compound module to use        
        string tier1Type; // tier 1 application to use
        string tier2Type;// tier 2 module to use
        string tier3Type; // tier 3 module to use
        int numTiers; // number of tiers
        double numOverlayModulesPerNode; // number of parallel overlays
        string routingFile = default("");
        bool IPForward = default(false);

        @display("bgb=433,386");
    gates:
        input overlayNeighborArrowIn[]; // incoming gate for visualizing overlay neighborship with connection arrows
        output overlayNeighborArrowOut[]; // incoming gate for visualizing overlay neighborship with connection arrows
        output out; // Dummy gate for storing channel informations
        input in; // Dummy gate for connecting out

    submodules:
        notificationBoard: NotificationBoard {
            parameters:
                @display("p=56,224");
        }
        tier3[numOverlayModulesPerNode]: <tier3Type> like ITier {
            parameters:
                @display("p=64,64;i=block/segm");
        }
        tier2[numOverlayModulesPerNode]: <tier2Type> like ITier {
            parameters:
                @display("p=179,104;i=block/segm");
        }
        tier1[numOverlayModulesPerNode]: <tier1Type> like ITier {
            parameters:
                @display("p=290,162;i=block/segm");
        }
        overlay[numOverlayModulesPerNode]: <overlayType> like IOverlay {
            parameters:
                @display("p=370,216;i=block/network2");
        }
        udp: SimpleUDP {
            parameters:
                @display("p=370,342");
        }
        interfaceTable: InterfaceTable {
            parameters:
                @display("p=64,287");
        }
        neighborCache: NeighborCache {
            parameters:
                @display("p=168,287");
        }
        cryptoModule: CryptoModule {
            parameters:
                @display("p=56,162");
        }
        bootstrapList: BootstrapList {
            parameters:
                @display("p=168,224");

        }
    connections allowunconnected:
        bootstrapList.udpOut --> udp.appIn++;
        bootstrapList.udpIn <-- udp.appOut++;

        for i=0..numOverlayModulesPerNode-1 {
            tier1[i].to_lowerTier --> overlay[i].appIn if numTiers>0;
            tier1[i].from_lowerTier <-- overlay[i].appOut if numTiers>0;
            tier1[i].udpOut --> udp.appIn++ if numTiers>0;
            udp.appOut++ --> tier1[i].udpIn if numTiers>0;

            tier2[i].to_lowerTier --> tier1[i].from_upperTier if numTiers > 1;
            tier2[i].from_lowerTier <-- tier1[i].to_upperTier if numTiers > 1;
            tier2[i].udpOut --> udp.appIn++ if numTiers>1;
            udp.appOut++ --> tier2[i].udpIn if numTiers>1;

            tier3[i].to_lowerTier --> tier2[i].from_upperTier if numTiers > 2;
            tier3[i].from_lowerTier <-- tier2[i].to_upperTier if numTiers > 2;
            tier3[i].udpOut --> udp.appIn++ if numTiers>2;
            udp.appOut++ --> tier3[i].udpIn if numTiers>2;

            overlay[i].udpOut --> udp.appIn++;
            overlay[i].udpIn <-- udp.appOut++;

        }

}