countdown

Documentation

Overview

A countdown timer that will mostly be used by XDPoS v2 consensus engine

Index

• type CountdownTimer
  • func NewCountDown(duration time.Duration) *CountdownTimer
  • func (t *CountdownTimer) Reset(i interface{})
  • func (t *CountdownTimer) SetTimeoutDuration(duration time.Duration)
  • func (t *CountdownTimer) StopTimer()

Types

type CountdownTimer

type CountdownTimer struct {

	// Triggered when the countdown timer timeout for the `timeoutDuration` period, it will pass current timestamp to the callback function
	OnTimeoutFn func(time time.Time, i interface{}) error
	// contains filtered or unexported fields
}

func NewCountDown

func NewCountDown(duration time.Duration) *CountdownTimer

func (*CountdownTimer) Reset

func (t *CountdownTimer) Reset(i interface{})

Reset will start the countdown timer if it's already stopped, or simply reset the countdown time back to the defual `duration`

func (*CountdownTimer) SetTimeoutDuration

func (t *CountdownTimer) SetTimeoutDuration(duration time.Duration)

func (*CountdownTimer) StopTimer

func (t *CountdownTimer) StopTimer()

Completely stop the countdown timer from running.