node

Documentation

Index

• Variables
• type Node
  • func (n *Node) Restart() error
  • func (n *Node) Start() error
  • func (n *Node) Stop() error
• type Service

Variables

var (
	ErrNodeRunning = errors.New("node is already running")
	ErrNodeStopped = errors.New("node is not started")
)

Types

type Node

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

Node is a container for registering services.

func (*Node) Restart

func (n *Node) Restart() error

Restart stop a running node and start a new one.

func (*Node) Start

func (n *Node) Start() error

Start create a p2p node.

func (*Node) Stop

func (n *Node) Stop() error

Stop terminates the running the node and the services registered.

type Service

type Service interface {
	// Protocols retrieves the P2P protocols the service wishes to start.
	Protocols() []p2p.Protocol

	Start(server *p2p.Server) error

	Stop() error
}

Service registers to node after node starts.