Compound Module NTreeModules

Package: oversim.overlay.ntree
File: src/overlay/ntree/NTree.ned

(no description)

Usage diagram:

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram. Click here to see the full picture.

Inheritance diagram:

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram. Click here to see the full picture.

Gates:

Name	Direction	Description
udpIn	input	gate from the UDP layer
udpOut	output	gate to the UDP layer
tcpIn	input	gate from the TCP layer
tcpOut	output	gate to the TCP layer
appIn	input	gate from the application
appOut	output	gate to the application

Unassigned submodule parameters:

Name	Type	Description
nTree.rpcUdpTimeout	double	default timeout value for direct RPCs
nTree.rpcKeyTimeout	double	default timeout value for routed RPCs
nTree.optimizeTimeouts	bool	calculate timeouts from measured RTTs and network coordinates
nTree.rpcExponentialBackoff	bool	if true, doubles the timeout for every retransmission
nTree.localPort	int	UDP port for overlay messages
nTree.overlayId	int	identifies the overlay this node belongs to (used for multiple overlays)
nTree.debugOutput	bool	enable debug output
nTree.keyLength	int	overlay key length in bits
nTree.nodeId	string	optional nodeId as string in hexadecimal notation
nTree.useCommonAPIforward	bool	enable CommonAPI forward() calls
nTree.drawOverlayTopology	bool	draw arrow to successor node?
nTree.hopCountMax	int	maximum number of overlay hops
nTree.recNumRedundantNodes	int	numRedundantNodes for recursive routing
nTree.joinOnApplicationRequest	bool	only join the overlay on application request
nTree.collectPerHopDelay	bool	delay statistics for single hops
nTree.routeMsgAcks	bool	use RPCs for route messages
nTree.lookupRedundantNodes	int	number of next hops in each step
nTree.lookupParallelPaths	int	number of parallel paths
nTree.lookupParallelRpcs	int	number of nodes to ask in parallel
nTree.lookupVerifySiblings	bool	true, if siblings need to be authenticated with a ping
nTree.lookupMajoritySiblings	bool	true, if sibling candidates are selected by a majority decision if using parallel paths
nTree.lookupMerge	bool	true, if parallel Rpc results should be merged
nTree.lookupFailedNodeRpcs	bool	communicate failed nodes
nTree.lookupStrictParallelRpcs	bool	limited the number of concurrent rpcs to parameter parallelRpcs
nTree.lookupUseAllParallelResponses	bool	merge all parallel responses from earlier steps
nTree.lookupNewRpcOnEveryTimeout	bool	send a new RPC immediately after an RPC timeouts
nTree.lookupNewRpcOnEveryResponse	bool	send a new RPC after every response, even if there was no progress
nTree.lookupFinishOnFirstUnchanged	bool	finish lookup, if the last pending RPC returned without progress
nTree.lookupVisitOnlyOnce	bool	if true, the same node is never asked twice during a single lookup
nTree.lookupAcceptLateSiblings	bool	if true, a FindNodeResponse with sibling flag set is always accepted, even if it is from a previous lookup step
nTree.routingType	string	default routing mode (iterative, semi-recursive,...)
nTree.rejoinOnFailure	bool	rejoin after loosing connection to the overlay?
nTree.sendRpcResponseToLastHop	bool	needed by KBR protocols for NAT support
nTree.recordRoute	bool	record visited hops on route
nTree.dropFindNodeAttack	bool	if node is malicious, it tries a findNode attack
nTree.isSiblingAttack	bool	if node is malicious, it tries a isSibling attack
nTree.invalidNodesAttack	bool	if node is malicious, it tries a invalidNode attack
nTree.dropRouteMessageAttack	bool	if node is malicious, it drops all received BaseRouteMessages
nTree.measureAuthBlock	bool	if true, measure the overhead of signatures in rpc messages
nTree.restoreContext	bool	if true, a node rejoins with its old nodeId and malicious state
nTree.areaDimension	double	size of the play filed
nTree.joinDelay	double	delay between join retries (sec)
nTree.pingInterval	double	Ping nodes every pingInterval
nTree.maxChildren	int	the maximum number of childs in the laodbalancing tree
nTree.AOIWidth	double	the size of the area of interest (i.e. subscriptionSize)

Source code:

module NTreeModules like IOverlay
{
    gates:
        input udpIn;    // gate from the UDP layer
        output udpOut;    // gate to the UDP layer
        input tcpIn;    // gate from the TCP layer
        output tcpOut;    // gate to the TCP layer
        input appIn;    // gate from the application
        output appOut;    // gate to the application

    submodules:
        nTree: NTree {
            parameters:
                @display("p=60,60");

        }
    connections allowunconnected:
        udpIn --> nTree.udpIn;
        udpOut <-- nTree.udpOut;
        appIn --> nTree.appIn;
        appOut <-- nTree.appOut;
}