discovery

Documentation

Index

• Constants
• type Config
• type Discovery
  • func New(cfg *Config) Discovery
• type Exception
  • func (n *Exception) String() string
• type FindNode
  • func (f *FindNode) String() string
• type Message
• type Neighbors
  • func (n *Neighbors) String() string
• type Node
  • func ParseNode(u string) (*Node, error)
  • func (n *Node) Deserialize(bytes []byte) error
  • func (n *Node) Serialize() ([]byte, error)
  • func (n *Node) String() string
  • func (n *Node) TCPAddr() *net.TCPAddr
  • func (n *Node) UDPAddr() *net.UDPAddr
  • func (n *Node) Update(n2 *Node)
  • func (n *Node) Validate() error
• type NodeID
  • func Bytes2NodeID(buf []byte) (id NodeID, err error)
  • func HexStr2NodeID(str string) (id NodeID, err error)
  • func Priv2NodeID(priv ed25519.PrivateKey) (NodeID, error)
  • func (id NodeID) Brief() string
  • func (id NodeID) Bytes() []byte
  • func (id NodeID) Equal(id2 NodeID) bool
  • func (id NodeID) IsZero() bool
  • func (id NodeID) String() string
• type Ping
  • func (p *Ping) String() string
• type Pong
  • func (p *Pong) String() string

Constants

const K = 128

K is the default bucketSize

const N = 16

N is the default number of buckets

const NodeURLScheme = "vnode"

Types

type Config

type Config struct {
	PeerKey   ed25519.PrivateKey
	DBPath    string
	BootNodes []*Node
	Addr      string
	NetID     network.ID
	Self      *Node
}

Config is the essential configuration to create a Discovery implementation

type Discovery

type Discovery interface {
	Start() error
	Stop()
	SubNodes(ch chan<- *Node, near bool)
	UnSubNodes(ch chan<- *Node)
	Mark(id NodeID, lifetime int64)
	UnMark(id NodeID)
	Block(id NodeID, ip net.IP)
	More(ch chan<- *Node, n int)
	Nodes() []string
	Delete(id NodeID)
}

Discovery is the interface to discovery other node

func New

func New(cfg *Config) Discovery

New create a Discovery implementation

type Exception

type Exception struct {
	Code eCode
}

func (*Exception) String

func (n *Exception) String() string

type FindNode

type FindNode struct {
	ID         NodeID
	Target     NodeID
	Expiration time.Time
	N          uint32
}

func (*FindNode) String

func (f *FindNode) String() string

type Message

type Message interface {
	String() string
	// contains filtered or unexported methods
}

type Neighbors

type Neighbors struct {
	ID         NodeID
	Nodes      []*Node
	Expiration time.Time
}

func (*Neighbors) String

func (n *Neighbors) String() string

type Node

type Node struct {
	ID  NodeID
	IP  net.IP
	UDP uint16
	TCP uint16
	Net network.ID
	Ext []byte
	// contains filtered or unexported fields
}

Node mean a node in vite P2P network

func ParseNode

func ParseNode(u string) (*Node, error)

ParseNode parse a url-like string to Node

func (*Node) Deserialize

func (n *Node) Deserialize(bytes []byte) error

Deserialize encoded data, []byte, to a Node, you must create the Node first, like following:

n := new(Node)
err := n.Deserialize(buf)

func (*Node) Serialize

func (n *Node) Serialize() ([]byte, error)

Serialize a Node to []byte

func (*Node) String

func (n *Node) String() string

String marshal node to url-like string which looks like:

vnode://<hex node id>
vnode://<hex node id>@<ip>:<udpPort>#<tcpPort>

func (*Node) TCPAddr

func (n *Node) TCPAddr() *net.TCPAddr

TCPAddr return the address that can be connected with tcp

func (*Node) UDPAddr

func (n *Node) UDPAddr() *net.UDPAddr

UDPAddr return the address that can communication with udp

func (*Node) Update

func (n *Node) Update(n2 *Node)

func (*Node) Validate

func (n *Node) Validate() error

Validate whether a node has essential information

type NodeID

type NodeID [32]byte

NodeID use to mark node, and build a structural network

var ZERO_NODE_ID NodeID

ZERO_NODE_ID is the zero-value of NodeID type

func Bytes2NodeID

func Bytes2NodeID(buf []byte) (id NodeID, err error)

Bytes2NodeID turn a slice to NodeID

func HexStr2NodeID

func HexStr2NodeID(str string) (id NodeID, err error)

HexStr2NodeID parse a hex coded string to NodeID

func Priv2NodeID

func Priv2NodeID(priv ed25519.PrivateKey) (NodeID, error)

Priv2NodeID got the corresponding NodeID from ed25519.PeerKey

func (NodeID) Brief

func (id NodeID) Brief() string

Brief return the front 4 bytes hex coded string of NodeID

func (NodeID) Bytes

func (id NodeID) Bytes() []byte

Bytes return a slice derived from NodeID

func (NodeID) Equal

func (id NodeID) Equal(id2 NodeID) bool

Equal validate whether two NodeID is equal

func (NodeID) IsZero

func (id NodeID) IsZero() bool

IsZero validate whether a NodeID is zero-value

func (NodeID) String

func (id NodeID) String() string

String return a hex coded string of NodeID

type Ping

type Ping struct {
	ID         NodeID
	TCP        uint16
	Expiration time.Time
	Net        network.ID
	Ext        []byte
}

func (*Ping) String

func (p *Ping) String() string

type Pong

type Pong struct {
	ID         NodeID
	Ping       types.Hash
	IP         net.IP
	Expiration time.Time
}

func (*Pong) String

func (p *Pong) String() string