go.mway.dev/chrono@v0.6.1-0.20240126030049-189c5aef20d2/clock/timer.go (about)

     1  // Copyright (c) 2023 Matt Way
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to
     5  // deal in the Software without restriction, including without limitation the
     6  // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
     7  // sell copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
    18  // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
    19  // IN THE THE SOFTWARE.
    20  
    21  package clock
    22  
    23  import (
    24  	"time"
    25  )
    26  
    27  // A Timer is functionally equivalent to a [time.Timer]. A Timer must be
    28  // created by [Clock.NewTimer].
    29  type Timer struct {
    30  	C     <-chan time.Time
    31  	timer *time.Timer
    32  	fake  *fakeTimer
    33  }
    34  
    35  // Reset changes the timer to expire after duration d. It returns true if the
    36  // timer had been active, false if the timer had expired or been stopped.
    37  //
    38  // See Reset documentation on [time.Timer] for more information.
    39  func (t *Timer) Reset(d time.Duration) bool {
    40  	if t.timer != nil {
    41  		return t.timer.Reset(d)
    42  	}
    43  
    44  	return t.fake.resetTimer(d)
    45  }
    46  
    47  // Stop prevents the Timer from firing. It returns true if the call stops the
    48  // timer, false if the timer has already expired or been stopped. Stop does not
    49  // close the channel, to prevent a read from the channel succeeding
    50  // incorrectly.
    51  //
    52  // See Stop documentation on [time.Timer] for more information.
    53  func (t *Timer) Stop() bool {
    54  	if t.timer != nil {
    55  		return t.timer.Stop()
    56  	}
    57  	return t.fake.removeTimer()
    58  }