mode

Documentation

Overview

simple module to record the global running mode

Index

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

Constants

const (
	Stopped       = Mode(iota)
	Resynchronise = Mode(iota)
	Normal        = Mode(iota)
)

all possible modes

Functions

func ChainName

func ChainName() string

name of the current chain

func Finalise

func Finalise()

shutdown mode handling

func Initialise

func Initialise(chainName string)

set up the mode system

func Is

func Is(mode Mode) bool

detect mode

func IsNot

func IsNot(mode Mode) bool

detect mode

func IsTesting

func IsTesting() bool

special for testing

func Set

func Set(mode Mode)

change mode

func String

func String() string

current mode rep[resented as a string

Types

type Mode

type Mode int

type to hold the mode