clock

Documentation

Overview

Package clock provides tools for accessing time functions

Index

• func WithClock(parent context.Context, clock Clock) context.Context
• type Clock
  • func FromContext(ctx context.Context) Clock
• type Ticker
• type Timer

Functions

func WithClock

func WithClock(parent context.Context, clock Clock) context.Context

WithClock wraps parent in a new context with Clock

Types

type Clock

type Clock interface {
	Now() time.Time
	Since(t time.Time) time.Duration
	Until(t time.Time) time.Duration

	Sleep(d time.Duration)

	Timer(d time.Duration) Timer
	After(d time.Duration) <-chan time.Time
	AfterFunc(d time.Duration, f func()) Timer

	Ticker(d time.Duration) Ticker

	WithDeadline(parent context.Context, deadline time.Time) (context.Context, context.CancelFunc)
	WithTimeout(parent context.Context, timeout time.Duration) (context.Context, context.CancelFunc)
}

Clock is an interface for accessing time functions

func FromContext

func FromContext(ctx context.Context) Clock

FromContext returns Clock from context

type Ticker

type Ticker interface {
	C() <-chan time.Time
	Stop()
	Reset(d time.Duration)
}

Ticker is a time.Ticker interface

type Timer

type Timer interface {
	C() <-chan time.Time
	Stop() bool
	Reset(d time.Duration) bool
}

Timer is a time.Timer interface