kademlia

package module

v0.0.0-...-2e390db Latest Latest Go to latest Published: Oct 24, 2019 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/flightonary/kademlia

Links

Open Source Insights

README ¶

Kademlia

This is a golang implementation of a Kademlia for the purpose of studying. It is not recommended to use for production environment.

Installation

cli

$ go run cmd/kadcli.go LISTEN_IP LISTEN_PORT BOOTSTRAP_IP BOOTSTRAP_PORT

License

MIT

Documentation ¶

Index ¶

Constants
func DisableLog()
func GetHostIp() (net.IP, error)
func SetLogLevelDebug()
func SetLogLevelInfo()
type KadID
- func GenerateRandomKadId() KadID
type Kademlia
- func NewKademlia(own *Node) *Kademlia
type Node
- func NewNode(id KadID, ip net.IP, port int) *Node

Constants ¶

View Source

const BucketSize = 20

View Source

const KadIdLen = 160 // bits

View Source

const KadIdLenByte = KadIdLen / 8 // bytes

Variables ¶

This section is empty.

Functions ¶

func DisableLog ¶

func DisableLog()

func GetHostIp ¶

func GetHostIp() (net.IP, error)

func SetLogLevelDebug ¶

func SetLogLevelDebug()

func SetLogLevelInfo ¶

func SetLogLevelInfo()

Types ¶

type KadID ¶

type KadID [KadIdLenByte]byte

func GenerateRandomKadId ¶

func GenerateRandomKadId() KadID

type Kademlia ¶

type Kademlia struct {
	// contains filtered or unexported fields
}

func NewKademlia ¶

func NewKademlia(own *Node) *Kademlia

func (*Kademlia) Bootstrap ¶

func (kad *Kademlia) Bootstrap(entryNodeAddr string, entryNodePort int) error

func (*Kademlia) FindValue ¶

func (kad *Kademlia) FindValue(key string)

func (*Kademlia) GetRoutingTable ¶

func (kad *Kademlia) GetRoutingTable() [KadIdLen]list.List

For debug purpose

func (*Kademlia) Leave ¶

func (kad *Kademlia) Leave()

func (*Kademlia) SendFindNodeQuery ¶

func (kad *Kademlia) SendFindNodeQuery(ip net.IP, port int, target KadID) error

func (*Kademlia) SetFindValueCallback ¶

func (kad *Kademlia) SetFindValueCallback(fn func(string, []byte))

func (*Kademlia) Store ¶

func (kad *Kademlia) Store(key string, value []byte)

type Node ¶

type Node struct {
	Id   KadID
	IP   net.IP
	Port int
}

func NewNode ¶

func NewNode(id KadID, ip net.IP, port int) *Node

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
cmd

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL