ticker

README

ticker

This package implements a ticker that can be stopped and re-started.

Install with go get github.com/tjgq/ticker.

Browse the package documentation at http://godoc.org/github.com/tjgq/ticker.

Documentation

Overview

Package ticker implements a ticker that can be stopped and re-started.

Index

• type Ticker
  • func New(d time.Duration) *Ticker
  • func (t *Ticker) Start()
  • func (t *Ticker) Stop()
  • func (t *Ticker) Stopped() bool

Types

type Ticker

type Ticker struct {
	C chan time.Time // The channel on which ticks are delivered.
	// contains filtered or unexported fields
}

A Ticker holds a channel that delivers ticks at intervals.

func New

func New(d time.Duration) *Ticker

New returns a new ticker that ticks every d seconds. It adjusts the intervals or drops ticks to make up for slow receivers. The ticker is initially in the stopped state.

func (*Ticker) Start

func (t *Ticker) Start()

Start (re-)starts the ticker. Ticks will be delivered on the ticker's channel until Stop is called.

func (*Ticker) Stop

func (t *Ticker) Stop()

Stop stops the ticker. No ticks will be delivered on the ticker's channel after Stop returns and before Start is called again.

func (*Ticker) Stopped

func (t *Ticker) Stopped() bool

Stopped returns whether the ticker is stopped.