cooldown

Documentation

Index

• type Timer
  • func NewTimer(skipCleanup bool, cleanTimer time.Duration) *Timer
  • func (t *Timer) Active(key string, coolFor time.Duration) bool
  • func (t *Timer) Running() bool
  • func (t *Timer) Sizes() (int, int)
  • func (t *Timer) StopTimer()

Types

type Timer

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

Timer is used to set a cooldown timer on a key.

func NewTimer

func NewTimer(skipCleanup bool, cleanTimer time.Duration) *Timer

NewTimer returns a struct for which you can use Active().

func (*Timer) Active

func (t *Timer) Active(key string, coolFor time.Duration) bool

Active returns true if a cooldown timer is active for a key. If it's not active, it's saved (for next time).

func (*Timer) Running

func (t *Timer) Running() bool

Running returns false if StopTimer has been called; true otherwise.

func (*Timer) Sizes

func (t *Timer) Sizes() (int, int)

Sizes returns the tracked item length and the channel queue length.

func (*Timer) StopTimer

func (t *Timer) StopTimer()

StopTimer kills the active cooler. Do not call Active() after you call this method.