btree

type Bit ¶

type Bit bool

const (
	Bit0 Bit = false
	Bit1 Bit = true
)

type Bits ¶

type Bits []Bit

func (b Bits) Cmp(other Bits) int

func (b Bits) LeadingZeros() int

func (b Bits) String() string

type Btree ¶

type Btree interface {
	N() int
	Put(NodeID) PutResult
	Has(NodeID) bool
	Drop(NodeID) bool
	Closest(NodeID, int) []NodeID
	Count() int
}

Btree is the binary tree implementation used by the Kademlia routing table. The Kademlia literature refers to "buckets" that can be "split" according to certain rules when they are full. This implementation does not use buckets exactly as described in the literature, but rather a simpler binary tree, however the end result is largely equivalent.

func New(origin NodeID, k int, splittingEnabled bool) Btree

type NodeID ¶

type NodeID []byte

func MustParseBinaryNodeID(str string) NodeID

func ParseBinaryNodeID(str string) (NodeID, error)

func (id NodeID) BinaryString() string

func (id NodeID) Bits() Bits

func (id NodeID) Equals(other NodeID) bool

func (id NodeID) GetBit(n int) Bit

func (id NodeID) MustXor(other NodeID) NodeID

func (id NodeID) String() string

func (id NodeID) Xor(other NodeID) (NodeID, error)

type PrometheusCollector ¶ added in v0.2.0

type PrometheusCollector struct {
	Btree          Btree
	CountGauge     prometheus.Gauge
	AddedCounter   prometheus.Counter
	DroppedCounter prometheus.Counter
}

func (p PrometheusCollector) Closest(id NodeID, count int) []NodeID

func (p PrometheusCollector) Count() int

func (p PrometheusCollector) Drop(id NodeID) bool

func (p PrometheusCollector) Has(id NodeID) bool

func (p PrometheusCollector) N() int

func (p PrometheusCollector) Put(id NodeID) PutResult

type PutResult ¶

type PutResult int

const (
	PutRejected PutResult = iota
	PutAccepted
	PutAlreadyExists
)

func (r PutResult) String() string