Add Context cancellation to clock.

common/clock/timer.go

 // Copyright 2015 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 package clock
 
 import (
         "time"
 )
 
 // Timer is a wrapper around the time.Timer structure.
 //
 // A Timer is instantiated from a Clock instance and started via its Reset()
 // method.
 type Timer interface {
-        // GetC returns the underlying timer's channel, or nil if the timer is no
-        // running.
-        GetC() <-chan time.Time
+        // GetC returns the underlying timer's channel.

[iannucci, 2016/02/10 22:30:28]

doc behavior with Reset and Stop

[dnj (Google), 2016/02/11 01:26:55]

Done.

+        GetC() <-chan TimerResult
 
         // Reset configures the timer to expire after a specified duration.
         //
         // If the timer is already running, its previous state will be cleared and
         // this method will return true.
         Reset(d time.Duration) bool
 
         // Stop clears any timer tasking, rendering it inactive.
         //
         // Stop may be called on an inactive timer, in which case nothing will happen
         // If the timer is active, it will be stopped and this method will return true.
         Stop() bool
 }
+
+// TimerResult is the result fo a timer operation.

[iannucci, 2016/02/10 22:30:28]

fo'

[dnj (Google), 2016/02/11 01:26:55]

Done.

+//
+// If the timer operation completed successfully, the embedded time.Time will be
+// set to the time when the timer triggered. If the timer was prematurely
+// terminated, Err will be non-nil.

[iannucci, 2016/02/10 22:30:28]

time will be the time when the result was generated

[dnj (Google), 2016/02/11 01:26:55]

Done.

+type TimerResult struct {
+        time.Time
+
+        // Err, if not nil, indicates that After did not finish naturally and contains
+        // the reason why.
+        Err error
+}