networksharding

Documentation

Index

• Variables
• func Set(s Sharder) error
• type KadPeerShardResolver
• type Sharder
  • func Get() Sharder
  • func NewKadSharder(prioBits uint32, kgs KadPeerShardResolver) (Sharder, error)

Variables

var ErrAlreadySet = errors.New("already set")

ErrAlreadySet a sharder is already set

var ErrBadParams = errors.New("bad parameters")

ErrBadParams bad parameters

var ErrNilSharder = errors.New("nil sharder")

ErrNilSharder the sharder is nil

Functions

func Set

func Set(s Sharder) error

Set the sharder, can only be done once

Types

type KadPeerShardResolver

type KadPeerShardResolver interface {
	ByID(p2p.PeerID) uint32 //ByID get the shard id of the given peer.ID
	IsInterfaceNil() bool   //IsInterfaceNil returns true if there is no value under the interface
}

KadPeerShardResolver peer to shard mapping interface

type Sharder

type Sharder interface {
	// GetShard get the shard id of the peer
	GetShard(id peer.ID) uint32
	// GetDistance get the distance between a and b
	GetDistance(a, b sortingID) *big.Int
	// SortList sort the provided peers list
	SortList(peers []peer.ID, ref peer.ID) []peer.ID
}

Sharder - Main sharder interface

func Get

func Get() Sharder

Get the sharder

func NewKadSharder

func NewKadSharder(prioBits uint32, kgs KadPeerShardResolver) (Sharder, error)

NewKadSharder kadSharder constructor prioBits - Number of reseted bits. f - Callback used to get the shard id for a given peer.ID