idle

Documentation

Index

• Variables
• type IdleTimer
  • func New(d time.Duration) *IdleTimer
  • func (t *IdleTimer) Run(ctx context.Context) error
  • func (t *IdleTimer) SetActive()

Variables

var ErrTimedOut = errors.New("timed out due to no activity")

Types

type IdleTimer

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

IdleTimer is a dead-mans switch to detect inactivity. Create with New.

func New

func New(d time.Duration) *IdleTimer

New creates an IdleTimer that will return errors if the there is no activity seen for the given duration.

func (*IdleTimer) Run

func (t *IdleTimer) Run(ctx context.Context) error

Run runs until the context is cancelled or no-one calls SetActive for more than the timer's duration. Always returns an error, either the context's or ErrTimedOut.

func (*IdleTimer) SetActive

func (t *IdleTimer) SetActive()

SetActive marks this timer as still active.