File: Overlay/Kademlia/Kademlia.ned
Implementation of the Kademlia DHT overlay as described in "Kademlia: A peer-to-peer information system based on the XOR metric" by P. Maymounkov and D. Mazieres, published in "In Proceedings of IPTPS02"
Author: Sebastian Mies
The following diagram shows usage relationships between modules, networks and channels. Unresolved module (and channel) types are missing from the diagram. Click here to see the full picture.
If a module type shows up more than once, that means it has been defined in more than one NED file.
Kademlia | The main module of the Kademlia implementation |
Name | Direction | Description |
---|---|---|
from_udp | input | gate from the UDP layer |
to_udp | output | gate to the UDP layer |
from_app | input | gate from the application |
to_app | output | gate to the application |
Name | Type | Description |
---|---|---|
kademlia.localPort | numeric | base overlay parameters |
kademlia.debugOutput | bool | enable debug output |
kademlia.keyLength | numeric | overlay key length in bits |
kademlia.drawOverlayTopology | bool | draw arrow to successor node? |
kademlia.hopCountMax | numeric | maximum number of overlay hops |
kademlia.joinOnApplicationRequest | bool | only join the overlay on application request |
kademlia.useCommonAPIforward | bool | enable CommonAPI forward() calls |
kademlia.routeMsgAcks | bool | use RPCs for route messages |
kademlia.recNumRedundantNodes | numeric | numRedundantNodes for recursive routing |
kademlia.lookupRedundantNodes | numeric | lookup parameters |
kademlia.lookupParallelPaths | numeric | number of parallel paths |
kademlia.lookupParallelRpcs | numeric | number of nodes to ask in parallel |
kademlia.lookupSecure | bool | true, if all nodes should be identified with a ping |
kademlia.lookupMerge | bool | true, if parallel Rpc results should be merged |
kademlia.lookupStrictParallelRpcs | bool | limited the number of concurrent rpcs to parameter parallelRpcs |
kademlia.lookupUseAllParallelResponses | bool | merge all parallel responses from earlier steps |
kademlia.lookupNewRpcOnEveryTimeout | bool | send a new RPC immediately after an RPC timeouts |
kademlia.lookupNewRpcOnEveryResponse | bool | send a new RPC after every response, even if there was no progress |
kademlia.lookupFinishOnFirstUnchanged | bool | finish lookup, if the last pending RPC returned without progress |
kademlia.lookupFailedNodeRpcs | bool | communicate failed nodes lookups |
kademlia.routingType | string | default routing mode (iterative, semi-recursive,...) |
kademlia.collectPerHopDelay | bool | delay statistics for single hops |
kademlia.minSiblingTableRefreshInterval | numeric | kademlia parameters |
kademlia.minBucketRefreshInterval | numeric | bucket refresh delay |
kademlia.maxStaleCount | numeric | number of timeouts before node removal |
kademlia.k | numeric | number of paths (size of k-bucket) |
kademlia.b | numeric | network diameter O(log_{2^(b)}) |
kademlia.s | numeric | number of siblings |
kademlia.pingNewSiblings | bool | ping new unknown siblings? |
kademlia.activePing | bool | ping new neighbors? |
module KademliaModules gates: in: from_udp; // gate from the UDP layer out: to_udp; // gate to the UDP layer in: from_app; // gate from the application out: to_app; // gate to the application submodules: kademlia: Kademlia; display: "p=60,60;i=block/circle"; connections nocheck: from_udp --> kademlia.from_udp++; to_udp <-- kademlia.to_udp++; from_app --> kademlia.from_app; to_app <-- kademlia.to_app; endmodule