forked from cockroachdb/cockroach
/
clock.go
68 lines (55 loc) · 1.81 KB
/
clock.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
// Copyright 2014 The Cockroach Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License. See the AUTHORS file
// for names of contributors.
//
// Author: Ben Darnell
package multiraft
import "time"
// Ticker encapsulates the timing-related parts of the raft protocol.
type Ticker interface {
// This channel will be readable once per tick. The time value returned is unspecified;
// the channel has this type for compatibility with time.Ticker but other implementations
// may not return real times.
Chan() <-chan time.Time
// Close stops the ticker and releases its resources.
Close()
}
type realTicker struct {
*time.Ticker
}
func newTicker(interval time.Duration) Ticker {
return &realTicker{time.NewTicker(interval)}
}
func (t *realTicker) Chan() <-chan time.Time {
return t.C
}
func (t *realTicker) Close() {
t.Ticker.Stop()
}
// manualTicker is a fake implementation of the Ticker interface. With this ticker
// time does not flow normally, but time-based events can be triggered manually with
// the Tick method.
type manualTicker struct {
ch chan time.Time
}
func newManualTicker() *manualTicker {
return &manualTicker{make(chan time.Time)}
}
func (m *manualTicker) Chan() <-chan time.Time {
return m.ch
}
func (m *manualTicker) Tick() {
m.ch <- time.Time{}
}
func (m *manualTicker) Close() { /* do nothing */ }