registry

Documentation

Overview

Package registry provides node information caching and retrieval

Index

• Constants
• type NodeRegistry
  • func New(logger *zap.SugaredLogger, ports config.Ports, nodes ...*ipfs.NodeInfo) *NodeRegistry
  • func (r *NodeRegistry) Close()
  • func (r *NodeRegistry) Deregister(network string) error
  • func (r *NodeRegistry) Get(network string) (ipfs.NodeInfo, error)
  • func (r *NodeRegistry) List() []ipfs.NodeInfo
  • func (r *NodeRegistry) Register(node *ipfs.NodeInfo) error

Constants

const (
	// ErrInvalidNetwork is returned when an invalid node ID is provided
	ErrInvalidNetwork = "invalid node network"

	// ErrNetworkExists is returned when an network is provided that already exists
	ErrNetworkExists = "network already exists"
)

Types

type NodeRegistry

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

NodeRegistry manages data on active nodes

func New

func New(logger *zap.SugaredLogger, ports config.Ports, nodes ...*ipfs.NodeInfo) *NodeRegistry

New sets up a new registry with provided nodes

func (*NodeRegistry) Close

func (r *NodeRegistry) Close()

Close stops registry background jobs

func (*NodeRegistry) Deregister

func (r *NodeRegistry) Deregister(network string) error

Deregister removes node with given network

func (*NodeRegistry) Get

func (r *NodeRegistry) Get(network string) (ipfs.NodeInfo, error)

Get retrieves details about node with given network

func (*NodeRegistry) List

func (r *NodeRegistry) List() []ipfs.NodeInfo

List retrieves a list of all known nodes

func (*NodeRegistry) Register

func (r *NodeRegistry) Register(node *ipfs.NodeInfo) error

Register registers a node and allocates appropriate ports