mode

Documentation

Overview

Package mode - simple module to record the global running mode

Index

• func ChainName() string
• func Finalise() error
• func Initialise(chainName string) error
• func Is(mode Mode) bool
• func IsNot(mode Mode) bool
• func IsTesting() bool
• func Set(mode Mode)
• func String() string
• type Mode
  • func (m Mode) String() string

Functions

func ChainName

func ChainName() string

ChainName - name of the current chain

func Finalise

func Finalise() error

Finalise - shutdown mode handling

func Initialise

func Initialise(chainName string) error

Initialise - set up the mode system

func Is

func Is(mode Mode) bool

Is - detect mode

func IsNot

func IsNot(mode Mode) bool

IsNot - detect mode

func IsTesting

func IsTesting() bool

IsTesting - special for testing

func Set

func Set(mode Mode)

Set - change mode

func String

func String() string

String - current mode represented as a string

Types

type Mode

type Mode int

Mode - type to hold the mode

const (
	Stopped Mode = iota
	Resynchronise
	Normal
)

all possible modes

func (Mode) String

func (m Mode) String() string

String - current mode represented as a string