state

Documentation

Overview

Package state collects functionality for verifying states of network map members.

NetMapCandidateValidator type provides an interface for checking the network map candidates.

Index

• Variables
• type NetMapCandidateValidator
  • func (x *NetMapCandidateValidator) SetNetworkSettings(netSettings NetworkSettings)
  • func (x *NetMapCandidateValidator) Verify(node netmap.NodeInfo) error
• type NetworkSettings

Variables

var ErrMaintenanceModeDisallowed = errors.New("maintenance mode is disallowed")

ErrMaintenanceModeDisallowed is returned when maintenance mode is disallowed.

Types

type NetMapCandidateValidator

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

NetMapCandidateValidator represents tool which checks state of nodes which are going to register in the NeoFS network (enter the network map).

NetMapCandidateValidator can be instantiated using built-in var declaration and currently doesn't require any additional initialization.

NetMapCandidateValidator implements github.com/nspcc-dev/neofs-node/pkg/innerring/processors/netmap.NodeValidator.

func (*NetMapCandidateValidator) SetNetworkSettings

func (x *NetMapCandidateValidator) SetNetworkSettings(netSettings NetworkSettings)

SetNetworkSettings specifies provider of the NetworkSettings interface. MUST be called before any VerifyAndUpdate call. Parameter MUST NOT be nil.

func (*NetMapCandidateValidator) Verify

func (x *NetMapCandidateValidator) Verify(node netmap.NodeInfo) error

Verify checks state of the network map candidate described by netmap.NodeInfo parameter. Returns no error if status is correct, otherwise returns an error describing a violation of the rules:

status MUST be either ONLINE or MAINTENANCE;
if status is MAINTENANCE, then it SHOULD be allowed by the network.

Verify does not mutate the parameter in a binary format. MUST NOT be called before SetNetworkSettings.

See also netmap.NodeInfo.IsOnline/SetOnline and other similar methods.

type NetworkSettings

type NetworkSettings interface {
	// MaintenanceModeAllowed checks if maintenance state of the storage nodes
	// is allowed to be set, and returns:
	//  no error if allowed;
	//  ErrMaintenanceModeDisallowed if disallowed;
	//  other error if there are any problems with the check.
	MaintenanceModeAllowed() error
}

NetworkSettings encapsulates current settings of the NeoFS network and provides interface used for processing the network map candidates.