state

Documentation

Index

• type State
  • func (s *State) Advance(newState State)
  • func (s *State) Get() State
  • func (s *State) Require(states ...State) error
  • func (i State) String() string

Types

type State

type State uint32

State is a peer's state.

State's methods are thread safe. Get the State's value using the Get method if you're accessing it concurrently. Otherwise, you may access it directly.

const (
	// Uninitialized is the initial state.
	Uninitialized State = iota
	// AcceptingInit is the state where the peer is accepting an init message.
	AcceptingInit
	// JoiningCluster is the state where the peer is about to join the cluster.
	JoiningCluster
	// Initialized is the state where the peer is initializing.
	Initialized
	// Failed is the state where the peer has failed.
	Failed
)

func (*State) Advance

func (s *State) Advance(newState State)

Advance advances the state.

func (*State) Get

func (s *State) Get() State

Get gets the state in a thread-safe manner.

func (*State) Require

func (s *State) Require(states ...State) error

Require checks if the state is one of the desired ones and returns an error otherwise.

func (State) String

func (i State) String() string