Compound Module MyOverlayModules

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

Source code:

module MyOverlayModules 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:
        overlay: MyOverlay;
    connections allowunconnected:
        udpIn --> overlay.udpIn;
        udpOut <-- overlay.udpOut;
        appIn --> overlay.appIn;
        appOut <-- overlay.appOut;
}