discovery

Documentation

Index

• Constants
• func StartService(nodeDir string, myID common.Address, myAddr *net.UDPAddr, bootstrap []*Node, ...) (*Database, *UDP)
• type Database
  • func NewDatabase(log *log.ScdoLog) *Database
  • func (db *Database) FindByNodeID(id common.Address) (*Node, bool)
  • func (db *Database) GetCopy() map[common.Hash]*Node
  • func (db *Database) SaveNodes(nodeDir string)
  • func (db *Database) SetHookForDeleteNode(hook NodeHook)
  • func (db *Database) SetHookForNewNode(hook NodeHook)
  • func (db *Database) StartSaveNodes(nodeDir string, done chan struct{})
• type Node
  • func MustNewNodeWithAddr(id common.Address, addr string, shard uint) *Node
  • func NewNode(id common.Address, ip net.IP, port int, shard uint) *Node
  • func NewNodeFromIP(ip string) (*Node, error)
  • func NewNodeFromString(id string) (*Node, error)
  • func NewNodeWithAddr(id common.Address, addr *net.UDPAddr, shard uint) *Node
  • func NewNodeWithAddrString(id common.Address, addr string, shard uint) (*Node, error)
  • func (n *Node) GetUDPAddr() *net.UDPAddr
  • func (n Node) MarshalText() ([]byte, error)
  • func (n *Node) String() string
  • func (n *Node) UnmarshalText(json []byte) error
• type NodeHook
• type Table
  • func (t *Table) GetRandNodes(number int) []*Node
• type UDP
  • func (u *UDP) AddTrustNode(strNode string) error
  • func (u *UDP) GetBlockListCount() int
  • func (u *UDP) GetToTrustNodeCount() int
  • func (u *UDP) StartServe(nodeDir string)

Constants

const (
	// NodesBackupInterval is the nodes info of backup interval time
	NodesBackupInterval = time.Minute * 20

	// NodesBackupFileName is the nodes info of backup file name
	NodesBackupFileName = "nodes.json"
)

const (

	// UndefinedShardNumber indicates the shard number is undefined
	UndefinedShardNumber = 0
)

Functions

func StartService

func StartService(nodeDir string, myID common.Address, myAddr *net.UDPAddr, bootstrap []*Node, shard uint) (*Database, *UDP)

StartService start node udp service

Types

type Database

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

Database definition

func NewDatabase

func NewDatabase(log *log.ScdoLog) *Database

NewDatabase new database

func (*Database) FindByNodeID

func (db *Database) FindByNodeID(id common.Address) (*Node, bool)

FindByNodeID find node by its id

func (*Database) GetCopy

func (db *Database) GetCopy() map[common.Hash]*Node

GetCopy get replica from db.nodes

func (*Database) SaveNodes

func (db *Database) SaveNodes(nodeDir string)

SaveNodes dump nodes info into disk file

func (*Database) SetHookForDeleteNode

func (db *Database) SetHookForDeleteNode(hook NodeHook)

SetHookForDeleteNode this hook will be called when we lost a Node's connection Note it will run in a new go routine

func (*Database) SetHookForNewNode

func (db *Database) SetHookForNewNode(hook NodeHook)

SetHookForNewNode this hook will be called when find new Node Note it will run in a new go routine

func (*Database) StartSaveNodes

func (db *Database) StartSaveNodes(nodeDir string, done chan struct{})

StartSaveNodes will save to a file and open a timer to backup the nodes info

type Node

type Node struct {
	ID               common.Address //public key actually
	IP               net.IP
	UDPPort, TCPPort int

	Shard uint //node shard number
	// contains filtered or unexported fields
}

Node the node that contains its public key and network address

func MustNewNodeWithAddr

func MustNewNodeWithAddr(id common.Address, addr string, shard uint) *Node

MustNewNodeWithAddr new node with id and network address, and panics on any error.

func NewNode

func NewNode(id common.Address, ip net.IP, port int, shard uint) *Node

NewNode new node with its value

func NewNodeFromIP

func NewNodeFromIP(ip string) (*Node, error)

NewNodeFromIP new node from ip address

func NewNodeFromString

func NewNodeFromString(id string) (*Node, error)

NewNodeFromString new node from id

func NewNodeWithAddr

func NewNodeWithAddr(id common.Address, addr *net.UDPAddr, shard uint) *Node

NewNodeWithAddr new node with id and network address

func NewNodeWithAddrString

func NewNodeWithAddrString(id common.Address, addr string, shard uint) (*Node, error)

NewNodeWithAddrString new node with id and network address.

func (*Node) GetUDPAddr

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

GetUDPAddr get UDPAddr from node struct

func (Node) MarshalText

func (n Node) MarshalText() ([]byte, error)

MarshalText marshal node to json

func (*Node) String

func (n *Node) String() string

func (*Node) UnmarshalText

func (n *Node) UnmarshalText(json []byte) error

UnmarshalText unmarshal json to node

type NodeHook

type NodeHook func(node *Node)

NodeHook some hook funcs

type Table

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

Table used to save peers information

func (*Table) GetRandNodes

func (t *Table) GetRandNodes(number int) []*Node

type UDP

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

func (*UDP) AddTrustNode

func (u *UDP) AddTrustNode(strNode string) error

AddTrustedNode will add the node into the trustNodes, then the loop pingpong service will pingpong it.

func (*UDP) GetBlockListCount

func (u *UDP) GetBlockListCount() int

func (*UDP) GetToTrustNodeCount

func (u *UDP) GetToTrustNodeCount() int

func (*UDP) StartServe

func (u *UDP) StartServe(nodeDir string)