1 // Copyright 2009 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
9 // A Ticker holds a synchronous channel that delivers `ticks' of a clock
12 C <-chan Time // The channel on which the ticks are delivered.
16 // NewTicker returns a new Ticker containing a channel that will send the
17 // time, in nanoseconds, with a period specified by the duration argument.
18 // It adjusts the intervals or drops ticks to make up for slow receivers.
19 // The duration d must be greater than zero; if not, NewTicker will panic.
20 func NewTicker(d Duration) *Ticker {
22 panic(errors.New("non-positive interval for NewTicker"))
24 // Give the channel a 1-element time buffer.
25 // If the client falls behind while reading, we drop ticks
26 // on the floor until the client catches up.
27 c := make(chan Time, 1)
31 when: nano() + int64(d),
41 // Stop turns off a ticker. After Stop, no more ticks will be sent.
42 func (t *Ticker) Stop() {
46 // Tick is a convenience wrapper for NewTicker providing access to the ticking
47 // channel only. Useful for clients that have no need to shut down the ticker.
48 func Tick(d Duration) <-chan Time {