netmap

Documentation

Index

• func GetLatestNetworkMap(src Source) (*netmap.NetMap, error)
• func GetPreviousNetworkMap(src Source) (*netmap.NetMap, error)
• type AnnouncedKeys
• type Node
  • func (x Node) ExternalAddresses() []string
  • func (x Node) IterateAddresses(f func(string) bool)
  • func (x Node) NumberOfAddresses() int
  • func (x Node) PublicKey() []byte
• type Nodes
• type Source
• type State

Functions

func GetLatestNetworkMap

func GetLatestNetworkMap(src Source) (*netmap.NetMap, error)

GetLatestNetworkMap requests and returns the latest network map from the storage.

func GetPreviousNetworkMap

func GetPreviousNetworkMap(src Source) (*netmap.NetMap, error)

GetPreviousNetworkMap requests and returns previous from the latest network map from the storage.

Types

type AnnouncedKeys

type AnnouncedKeys interface {
	// Checks if the key was announced by a local node.
	IsLocalKey(key []byte) bool
}

AnnouncedKeys is an interface of utility for working with the announced public keys of the storage nodes.

type Node

type Node netmap.NodeInfo

Node is a named type of netmap.NodeInfo which provides interface needed in the current repository. Node is expected to be used everywhere instead of direct usage of netmap.NodeInfo, so it represents a type mediator.

func (Node) ExternalAddresses

func (x Node) ExternalAddresses() []string

ExternalAddresses returns external addresses of a node.

func (Node) IterateAddresses

func (x Node) IterateAddresses(f func(string) bool)

IterateAddresses iterates over all announced network addresses and passes them into f. Handler MUST NOT be nil.

func (Node) NumberOfAddresses

func (x Node) NumberOfAddresses() int

NumberOfAddresses returns number of announced network addresses.

func (Node) PublicKey

func (x Node) PublicKey() []byte

PublicKey returns public key bound to the storage node.

Return value MUST NOT be mutated, make a copy first.

type Nodes

type Nodes []netmap.NodeInfo

Nodes is a named type of []netmap.NodeInfo which provides interface needed in the current repository. Nodes is expected to be used everywhere instead of direct usage of []netmap.NodeInfo, so it represents a type mediator.

type Source

type Source interface {
	// GetNetMap reads the diff-th past network map from the storage.
	// Calling with zero diff returns the latest network map.
	// It returns the pointer to the requested network map and any error encountered.
	//
	// GetNetMap must return exactly one non-nil value.
	// GetNetMap must return ErrNotFound if the network map is not in the storage.
	//
	// Implementations must not retain the network map pointer and modify
	// the network map through it.
	GetNetMap(diff uint64) (*netmap.NetMap, error)

	// GetNetMapByEpoch reads network map by the epoch number from the storage.
	// It returns the pointer to the requested network map and any error encountered.
	//
	// Must return exactly one non-nil value.
	//
	// Implementations must not retain the network map pointer and modify
	// the network map through it.
	GetNetMapByEpoch(epoch uint64) (*netmap.NetMap, error)

	// Epoch reads the current epoch from the storage.
	// It returns thw number of the current epoch and any error encountered.
	//
	// Must return exactly one non-default value.
	Epoch() (uint64, error)
}

Source is an interface that wraps basic network map receiving method.

type State

type State interface {
	// CurrentEpoch returns the number of the current NeoFS epoch.
	CurrentEpoch() uint64
}

State groups the current system state parameters.