Simple Module Gia

Package: oversim.overlay.gia
File: src/overlay/gia/Gia.ned

C++ definition

The main module of the GIA implementation

Author: Robert Palmer

Gia

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
GiaModules compound module

Implementation of the Gia overlay as described in "Making Gnutella-like P2P Systems Scalable" by Yatin Chawathe, Sylvia Ratnasamy, Lee Breslau, Nick Lanham and Scott Shenker, published in "In Proc. ACM SIGCOMM (Aug. 2003)".

Author: Robert Palmer

Parameters:

Name Type Default value 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

maxNeighbors int

maximum number of neighbors

minNeighbors int

minimum number of neighbors

maxTopAdaptionInterval double

maximum topology adaption interval

topAdaptionAggressiveness int

topology adaption aggressiveness

maxLevelOfSatisfaction double

maximum level of satisfaction

maxHopCount int

maximum TTL for sent messages

messageTimeout double

message timeout

neighborTimeout double

neighbor timeout

sendTokenTimeout double

token timeout

tokenWaitTime double

delay when sending new token

keyListDelay double

delay when sending new key list to our neighbors

updateDelay double

delay between two update messages

outputNodeDetails bool

output node details

optimizeReversePath bool

use optimized reverse path?

Properties:

Name Value Description
class Gia
display i=block/circle

Gates:

Name Direction Size 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 GIA implementation
// @author Robert Palmer
simple Gia extends BaseOverlay
{
    parameters:
        @class(Gia);
        int maxNeighbors; // maximum number of neighbors
        int minNeighbors; // minimum number of neighbors
        double maxTopAdaptionInterval @unit(s); // maximum topology adaption interval
        int topAdaptionAggressiveness; // topology adaption aggressiveness
        double maxLevelOfSatisfaction; // maximum level of satisfaction
        int maxHopCount; // maximum TTL for sent messages
        double messageTimeout @unit(s); // message timeout
        double neighborTimeout @unit(s); // neighbor timeout
        double sendTokenTimeout @unit(s); // token timeout
        double tokenWaitTime @unit(s); // delay when sending new token        
        double keyListDelay @unit(s); // delay when sending new key list to our neighbors
        double updateDelay @unit(s); // delay between two update messages
        bool outputNodeDetails; // output node details
        bool optimizeReversePath; // use optimized reverse path?
}