Compound Module OverlayPubSubMMOG

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

Source code:

module OverlayPubSubMMOG 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:
        pubSubMMOG: PubSubMMOG {
            parameters:
                @display("p=60,60");

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