Simple Module Broose

Package: oversim.overlay.broose
File: src/overlay/broose/Broose.ned

The main module of the Broose implementation

Author: Jochen Schenk, Ingmar Baumgart

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.

Extends:

Name	Type	Description
BaseOverlay	simple module	Base class for overlay implementations

Used in compound modules:

Name	Type	Description
BrooseModules	compound module	Implementation of the Broose overlay as described in "Broose: A Practical Distributed Hashtable based on the De-Bruijn Topology" by A. Gai and L. Viennot, published in "Technical report, INRIA, june 2004"

Parameters:

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

Properties:

Name	Value	Description
class	Broose
display	i=block/circle

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
direct_in	input	gate for sendDirect

Source code:

//
// The main module of the Broose implementation
//
// @author Jochen Schenk, Ingmar Baumgart
//
simple Broose extends BaseOverlay
{
    parameters:
        @class(Broose);
        int bucketSize;    // number of nodes a bucket contains
        int rBucketSize;    // number of nodes a right-bucket contains
        double joinDelay @unit(s);    // time to wait to join the overlay after simulation start 
        int brooseShiftingBits;    // number of bits shifted in/out each step
        int userDist;    // number of hops that are added to the estimated hop count
        double refreshTime @unit(s);    // idle time after which a node is pinged
        int numberRetries;    // number of retries in case of timeout
        bool stab1;
        bool stab2;
}