Compound Module SingleHost

File: Underlay/SingleHostUnderlay/SingleHost.ned

(no description)

notificationBoard: NotificationBoard interfaceTable: InterfaceTable routingTable: RoutingTable packetParser: parser like PacketParser applicationParser: appParser like PacketParser tier3: tier3Type like Tier tier2: tier2Type like Tier tier1: tier1Type like Tier overlay: overlayType like Overlay udp: UDP networkLayer: NetworkLayer tunDev: TunOutDevice

Usage diagram:

The following diagram shows usage relationships between modules, networks and channels. Unresolved module (and channel) types are missing from the diagram. Click here to see the full picture.

Contains the following modules:

If a module type shows up more than once, that means it has been defined in more than one NED file.

Overlay (no description)
PacketParser (no description)
Tier

A template for Tier1-3 modules

TunOutDevice (no description)
NotificationBoard (unknown -- not in documented files)
InterfaceTable (unknown -- not in documented files)
RoutingTable (unknown -- not in documented files)
UDP (unknown -- not in documented files)
NetworkLayer (unknown -- not in documented files)

Used in compound modules:

If a module type shows up more than once, that means it has been defined in more than one NED file.

SingleHostUnderlay

The SingleHostUnderlay ned-file

See also: SingleHostConfigurator

Parameters:

Name Type Description
IPForward bool
overlayType string
tier1Type string

tier 1 module to use

tier2Type string

tier 2 module to use

tier3Type string

tier 3 module to use

numTiers numeric const

number of tiers

parser string
appParser string
routingFile string

Gates:

Name Direction Description
overlayNeighborArrowIn [ ] input
overlayNeighborArrowOut [ ] output

Unassigned submodule parameters:

Name Type Description
tunDev.mtu numeric

Source code:

module SingleHost
    parameters:
        IPForward: bool,
        overlayType: string,
        tier1Type: string, // tier 1 module to use
        tier2Type: string, // tier 2 module to use
        tier3Type: string, // tier 3 module to use
        numTiers: numeric const, // number of tiers
        parser: string,
        appParser: string,
        routingFile: string;

    gates:
        in: overlayNeighborArrowIn[];

        out: overlayNeighborArrowOut[];

    submodules:
        notificationBoard: NotificationBoard;
            display: "p=68,136;i=block/control";
        interfaceTable: InterfaceTable;
            display: "p=68,206;i=block/table";
        routingTable: RoutingTable;
            parameters:
                IPForward = IPForward,
                routerId = "",
                routingFile = routingFile;
            display: "p=68,276;i=block/table";
        packetParser: parser like PacketParser;
            display: "p=179,270;i=block/wheelbarrow";
        applicationParser: appParser like PacketParser;
            display: "p=179,356;i=block/wheelbarrow";
        tier3: tier3Type like Tier;
            display: "p=64,56;i=block/segm";
        tier2: tier2Type like Tier;
            display: "p=131,56;i=block/segm";
        tier1: tier1Type like Tier;
            display: "p=202,58;i=block/segm";
        overlay: overlayType like Overlay;
            display: "p=266,128;i=block/network2";
        udp: UDP;
            display: "p=266,198;i=block/transport";
        networkLayer: NetworkLayer;
            parameters:
                proxyARP = false;
            gatesizes:
                ifIn[1],
                ifOut[1];
            display: "p=266,268;i=block/fork;q=queue";
        tunDev: TunOutDevice;
            display: "p=266,358,row,90;q=txQueue;i=block/ifcard";
    connections nocheck:
        tier1.to_lowerTier --> overlay.from_app if numTiers > 0;
        tier1.from_lowerTier <-- overlay.to_app if numTiers > 0;
        tier1.to_udp --> udp.from_app++ if numTiers > 0;
        udp.to_app++ --> tier1.from_udp if numTiers > 0 display "m=,100,28,100,28";

        tier2.to_lowerTier --> tier1.from_upperTier if numTiers > 1;
        tier2.from_lowerTier <-- tier1.to_upperTier if numTiers > 1;
        tier2.to_udp --> udp.from_app++ if numTiers > 1;
        udp.to_app++ --> tier2.from_udp if numTiers > 1;

        tier3.to_lowerTier --> tier2.from_upperTier if numTiers > 2;
        tier3.from_lowerTier <-- tier2.to_upperTier if numTiers > 2;
        tier3.to_udp --> udp.from_app++ if numTiers > 2;
        udp.to_app++ --> tier3.from_udp if numTiers > 2;

        overlay.to_udp --> udp.from_app++;
        overlay.from_udp <-- udp.to_app++;

        udp.to_ip --> networkLayer.UDPIn;
        udp.from_ip <-- networkLayer.UDPOut;

        // connections to network outside
        tunDev.netwOut --> networkLayer.ifIn[0];
        tunDev.netwIn <-- networkLayer.ifOut[0];

    display: "b=330,410";
endmodule