uptime

Documentation

Index

• type Calculator
• type LockedCalculator
  • func NewLockedCalculator() LockedCalculator
• type Manager
  • func NewManager(state State, clk *mockable.Clock) Manager
• type State
• type TestState
  • func NewTestState() *TestState
  • func (s *TestState) AddNode(nodeID ids.NodeID, startTime time.Time)
  • func (s *TestState) GetStartTime(nodeID ids.NodeID) (time.Time, error)
  • func (s *TestState) GetUptime(nodeID ids.NodeID) (time.Duration, time.Time, error)
  • func (s *TestState) SetUptime(nodeID ids.NodeID, upDuration time.Duration, lastUpdated time.Time) error
• type Tracker

Types

type Calculator

type Calculator interface {
	CalculateUptime(nodeID ids.NodeID) (time.Duration, time.Time, error)
	CalculateUptimePercent(nodeID ids.NodeID) (float64, error)
	// CalculateUptimePercentFrom expects [startTime] to be truncated (floored) to the nearest second
	CalculateUptimePercentFrom(nodeID ids.NodeID, startTime time.Time) (float64, error)
}

var NoOpCalculator Calculator = noOpCalculator{}

type LockedCalculator

type LockedCalculator interface {
	Calculator

	SetCalculator(isBootstrapped *utils.Atomic[bool], lock sync.Locker, newC Calculator)
}

func NewLockedCalculator

func NewLockedCalculator() LockedCalculator

type Manager

type Manager interface {
	Tracker
	Calculator
}

func NewManager

func NewManager(state State, clk *mockable.Clock) Manager

type State

type State interface {
	// GetUptime returns [upDuration] and [lastUpdated] of [nodeID]
	// Returns [database.ErrNotFound] if [nodeID] isn't currently a validator.
	GetUptime(
		nodeID ids.NodeID,
	) (upDuration time.Duration, lastUpdated time.Time, err error)

	// SetUptime updates [upDuration] and [lastUpdated] of [nodeID]
	// Returns [database.ErrNotFound] if [nodeID] isn't currently a validator
	// Invariant: expects [lastUpdated] to be truncated (floored) to the nearest
	//            second.
	SetUptime(
		nodeID ids.NodeID,
		upDuration time.Duration,
		lastUpdated time.Time,
	) error

	// GetStartTime returns the time that [nodeID] started validating.
	// Returns [database.ErrNotFound] if [nodeID] isn't currently a validator.
	GetStartTime(
		nodeID ids.NodeID,
	) (startTime time.Time, err error)
}

type TestState

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

func NewTestState

func NewTestState() *TestState

func (*TestState) AddNode

func (s *TestState) AddNode(nodeID ids.NodeID, startTime time.Time)

func (*TestState) GetStartTime

func (s *TestState) GetStartTime(nodeID ids.NodeID) (time.Time, error)

func (*TestState) GetUptime

func (s *TestState) GetUptime(nodeID ids.NodeID) (time.Duration, time.Time, error)

func (*TestState) SetUptime

func (s *TestState) SetUptime(nodeID ids.NodeID, upDuration time.Duration, lastUpdated time.Time) error

type Tracker

type Tracker interface {
	StartTracking(nodeIDs []ids.NodeID) error
	StopTracking(nodeIDs []ids.NodeID) error
	StartedTracking() bool

	Connect(nodeID ids.NodeID) error
	IsConnected(nodeID ids.NodeID) bool
	Disconnect(nodeID ids.NodeID) error
}