startup

Documentation

Index

• type Timer
  • func NewStartUpTimer(serviceKey string) Timer
  • func NewTimer(duration int, interval int) Timer
  • func (t Timer) HasNotElapsed() bool
  • func (t Timer) RemainingAsString() string
  • func (t Timer) SinceAsString() string
  • func (t Timer) SleepForInterval()

Types

type Timer

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

Timer contains references to dependencies required by the startup timer implementation.

func NewStartUpTimer

func NewStartUpTimer(serviceKey string) Timer

NewStartUpTimer is a factory method that returns an initialized Timer receiver struct.

func NewTimer

func NewTimer(duration int, interval int) Timer

NewTimer is a factory method that returns a Timer initialized with passed in duration and interval.

func (Timer) HasNotElapsed

func (t Timer) HasNotElapsed() bool

HasNotElapsed returns whether or not the duration specified during construction has elapsed.

func (Timer) RemainingAsString

func (t Timer) RemainingAsString() string

RemainingAsString returns the time remaining on the timer as a string.

func (Timer) SinceAsString

func (t Timer) SinceAsString() string

SinceAsString returns the time since the timer was created as a string.

func (Timer) SleepForInterval

func (t Timer) SleepForInterval()

SleepForInterval pauses execution for the interval specified during construction.