timeutil

Documentation

Index

• func Sleep(ctx context.Context, d time.Duration) bool
• type Ticker
  • func NewTicker(handler func(), interval time.Duration, ctx ...context.Context) (ticker *Ticker)
  • func (t *Ticker) Shutdown()
  • func (t *Ticker) WaitForGracefulShutdown()
  • func (t *Ticker) WaitForShutdown()

Functions

func Sleep

func Sleep(ctx context.Context, d time.Duration) bool

Sleep pauses the current goroutine for the duration d or until the context ctx is cancelled. It returns whether Sleep paused for the entire duration or was cancelled before that.

Types

type Ticker

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

Ticker is task that gets executed repeatedly. It adjusts the intervals or drops ticks to make up for slow executions.

func NewTicker

func NewTicker(handler func(), interval time.Duration, ctx ...context.Context) (ticker *Ticker)

NewTicker creates a new Ticker from the given details. The interval must be greater than zero; if not, NewTicker will panic.

func (*Ticker) Shutdown

func (t *Ticker) Shutdown()

Shutdown shuts down the Ticker.

func (*Ticker) WaitForGracefulShutdown

func (t *Ticker) WaitForGracefulShutdown()

WaitForGracefulShutdown waits until the Ticker was shut down and the last handler has terminated.

func (*Ticker) WaitForShutdown

func (t *Ticker) WaitForShutdown()

WaitForShutdown waits until the Ticker was shut down.