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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
|
// Copyright 2018 The dexon-consensus Authors
// This file is part of the dexon-consensus library.
//
// The dexon-consensus library is free software: you can redistribute it
// and/or modify it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the License,
// or (at your option) any later version.
//
// The dexon-consensus library is distributed in the hope that it will be
// useful, but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser
// General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with the dexon-consensus library. If not, see
// <http://www.gnu.org/licenses/>.
package core
import (
"context"
"fmt"
"sync"
"time"
"gitlab.com/byzantine-lab/tangerine-consensus/core/utils"
)
// TickerType is the type of ticker.
type TickerType int
// TickerType enum.
const (
TickerBA TickerType = iota
TickerDKG
TickerCRS
)
// defaultTicker is a wrapper to implement ticker interface based on
// time.Ticker.
type defaultTicker struct {
ticker *time.Ticker
tickerChan chan time.Time
duration time.Duration
ctx context.Context
ctxCancel context.CancelFunc
waitGroup sync.WaitGroup
}
// newDefaultTicker constructs an defaultTicker instance by giving an interval.
func newDefaultTicker(lambda time.Duration) *defaultTicker {
ticker := &defaultTicker{duration: lambda}
ticker.init()
return ticker
}
// Tick implements Tick method of ticker interface.
func (t *defaultTicker) Tick() <-chan time.Time {
return t.tickerChan
}
// Stop implements Stop method of ticker interface.
func (t *defaultTicker) Stop() {
t.ticker.Stop()
t.ctxCancel()
t.waitGroup.Wait()
t.ctx = nil
t.ctxCancel = nil
close(t.tickerChan)
t.tickerChan = nil
}
// Restart implements Stop method of ticker interface.
func (t *defaultTicker) Restart() {
t.Stop()
t.init()
}
func (t *defaultTicker) init() {
t.ticker = time.NewTicker(t.duration)
t.tickerChan = make(chan time.Time)
t.ctx, t.ctxCancel = context.WithCancel(context.Background())
t.waitGroup.Add(1)
go t.monitor()
}
func (t *defaultTicker) monitor() {
defer t.waitGroup.Done()
loop:
for {
select {
case <-t.ctx.Done():
break loop
case v := <-t.ticker.C:
select {
case t.tickerChan <- v:
default:
}
}
}
}
// newTicker is a helper to setup a ticker by giving an Governance. If
// the governace object implements a ticker generator, a ticker from that
// generator would be returned, else constructs a default one.
func newTicker(gov Governance, round uint64, tickerType TickerType) (t Ticker) {
type tickerGenerator interface {
NewTicker(TickerType) Ticker
}
if gen, ok := gov.(tickerGenerator); ok {
t = gen.NewTicker(tickerType)
}
if t == nil {
var duration time.Duration
switch tickerType {
case TickerBA:
duration = utils.GetConfigWithPanic(gov, round, nil).LambdaBA
case TickerDKG:
duration = utils.GetConfigWithPanic(gov, round, nil).LambdaDKG
default:
panic(fmt.Errorf("unknown ticker type: %d", tickerType))
}
t = newDefaultTicker(duration)
}
return
}
|