wake

README

go-wake

A simple library to manage waking up the host system from sleep.

Documentation

Index

• Variables
• func After(d time.Duration) <-chan time.Time
• func AllowSleep() error
• func PreventSleep() error
• func Sleep(d time.Duration)
• func Tick(d time.Duration) <-chan time.Time
• type Ticker
  • func NewTicker(d time.Duration) (t *Ticker)
  • func (t *Ticker) Stop()
• type Timer
  • func AfterFunc(d time.Duration, f func()) *Timer
  • func NewTimer(d time.Duration) *Timer
  • func (t *Timer) Reset(d time.Duration) (active bool)
  • func (t *Timer) Stop() (active bool)

Variables

var NotImplemented = errors.New("not implemented")

var SleepAlreadyAllowed = errors.New("sleep mode as already been allowed")

var SleepAlreadyPrevented = errors.New("sleep mode has already been prevented")

Functions

func After

func After(d time.Duration) <-chan time.Time

func AllowSleep

func AllowSleep() error

func PreventSleep

func PreventSleep() error

func Sleep

func Sleep(d time.Duration)

func Tick

func Tick(d time.Duration) <-chan time.Time

Types

type Ticker

type Ticker struct {
	*time.Ticker
	// contains filtered or unexported fields
}

func NewTicker

func NewTicker(d time.Duration) (t *Ticker)

func (*Ticker) Stop

func (t *Ticker) Stop()

type Timer

type Timer struct {
	*time.Timer
	// contains filtered or unexported fields
}

func AfterFunc

func AfterFunc(d time.Duration, f func()) *Timer

func NewTimer

func NewTimer(d time.Duration) *Timer

func (*Timer) Reset

func (t *Timer) Reset(d time.Duration) (active bool)

func (*Timer) Stop

func (t *Timer) Stop() (active bool)