timeutil

Documentation

Index

• type Ticker
  • func NewTicker(d time.Duration) *Ticker
  • func (t *Ticker) Duration() time.Duration
  • func (t *Ticker) Start(ctx context.Context)
  • func (t *Ticker) Tick()
  • func (t *Ticker) TickAt(at time.Time)
  • func (t *Ticker) TickCh() <-chan time.Time
• type VarTicker
  • func NewVarTicker(ds ...time.Duration) *VarTicker
  • func (t *VarTicker) Durations() []time.Duration
  • func (t *VarTicker) Start(ctx context.Context)
  • func (t *VarTicker) Tick()
  • func (t *VarTicker) TickAt(at time.Time)
  • func (t *VarTicker) TickCh() <-chan time.Time

Types

type Ticker

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

Ticker is a wrapper around time.Ticker that allows to manually invoke a tick and can be stopped via context.

func NewTicker

func NewTicker(d time.Duration) *Ticker

NewTicker returns a new Ticker instance. If d is 0, the ticker will not be started and only manual ticks will be possible.

func (*Ticker) Duration

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

Duration returns the ticker duration.

func (*Ticker) Start

func (t *Ticker) Start(ctx context.Context)

Start starts the ticker.

func (*Ticker) Tick

func (t *Ticker) Tick()

Tick sends a tick to the ticker channel. Ticker must be started before calling this method.

func (*Ticker) TickAt

func (t *Ticker) TickAt(at time.Time)

TickAt sends a tick to the ticker channel with the given time. Ticker must be started before calling this method.

func (*Ticker) TickCh

func (t *Ticker) TickCh() <-chan time.Time

TickCh returns the ticker channel.

type VarTicker

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

VarTicker is a wrapper around time.Ticker that allows to manually invoke a tick and can be stopped via context.

It allows to specify multiple durations. The ticker will tick at the specified durations and then repeat the last duration.

func NewVarTicker

func NewVarTicker(ds ...time.Duration) *VarTicker

NewVarTicker returns a new VarTicker instance.

func (*VarTicker) Durations

func (t *VarTicker) Durations() []time.Duration

Durations returns the ticker durations.

func (*VarTicker) Start

func (t *VarTicker) Start(ctx context.Context)

Start starts the ticker.

func (*VarTicker) Tick

func (t *VarTicker) Tick()

Tick sends a tick to the ticker channel. Ticker must be started before calling this method.

func (*VarTicker) TickAt

func (t *VarTicker) TickAt(at time.Time)

TickAt sends a tick to the ticker channel with the given time. Ticker must be started before calling this method.

func (*VarTicker) TickCh

func (t *VarTicker) TickCh() <-chan time.Time

TickCh returns the ticker channel.