networksharding

Documentation

Index

• Variables
• type NoSharder
  • func (ns *NoSharder) GetDistance(a, b sortingID) *big.Int
  • func (ns *NoSharder) GetShard(_ peer.ID) uint32
  • func (ns *NoSharder) IsInterfaceNil() bool
  • func (ns *NoSharder) SortList(peers []peer.ID, ref peer.ID) ([]peer.ID, bool)
• type Sharder
  • func NewKadSharder(prioBits uint32, kgs p2p.PeerShardResolver) (Sharder, error)

Variables

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

ErrBadParams bad parameters

Types

type NoSharder

type NoSharder struct {
}

NoSharder default sharder, only uses Kademlia distance in sorting

func (*NoSharder) GetDistance

func (ns *NoSharder) GetDistance(a, b sortingID) *big.Int

GetDistance Kademlia XOR distance

func (*NoSharder) GetShard

func (ns *NoSharder) GetShard(_ peer.ID) uint32

GetShard always 0

func (*NoSharder) IsInterfaceNil

func (ns *NoSharder) IsInterfaceNil() bool

IsInterfaceNil returns true if there is no value under the interface

func (*NoSharder) SortList

func (ns *NoSharder) SortList(peers []peer.ID, ref peer.ID) ([]peer.ID, bool)

SortList sort the list

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, bool)
	IsInterfaceNil() bool
}

Sharder - Main sharder interface

func NewKadSharder

func NewKadSharder(prioBits uint32, kgs p2p.PeerShardResolver) (Sharder, error)

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