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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
use core::fmt;
use std::{
collections::HashMap,
sync::{
Arc, Mutex,
atomic::{AtomicUsize, Ordering},
},
thread,
time::{Duration, Instant},
};
use flume::{Receiver, Sender};
use crate::{TickCommand, TickManagerHandle};
#[derive(Clone, Debug)]
pub enum Speed {
Fps(usize),
Interval(Duration),
}
impl Speed {
/// whether we are allowed to start a new main frame
pub fn new_frame(&self, last_frame: Instant) -> bool {
match self {
Speed::Fps(fps) => {
let duration = Duration::from_secs_f64(1.0 / *fps as f64);
last_frame + duration <= Instant::now()
}
Speed::Interval(dur) => last_frame + *dur <= Instant::now(),
}
}
pub fn get_duration(&self) -> Duration {
match self {
Speed::Fps(fps) => Duration::from_secs_f64(1.0 / *fps as f64),
Speed::Interval(dur) => *dur,
}
}
}
/// the state that will be sent to the Tick Hooks
#[derive(Debug)]
pub enum TickStateReply {
SelfID(HookID),
MemberID(MemberID),
Tick,
}
pub type HookID = usize;
pub type MemberID = usize;
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct MemberIdentifier {
pub hook_id: HookID,
pub member_id: MemberID,
}
impl fmt::Display for MemberIdentifier {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"MemberIdentifier {{ hook_id: {}, member_id: {} }}",
self.hook_id, self.member_id
)
}
}
#[derive(Clone, Debug)]
pub enum MemberState {
Finished,
Running,
Hidden,
}
pub type SpeedFactor = usize;
#[derive(Clone, Debug)]
pub struct MemberInfo {
/// the sender to send TickStateReply to the Tick Hook
pub sender: Sender<TickStateReply>,
pub state: MemberState,
/// last time this member was ticked
pub last_tick: Instant,
}
type InternalMap = HashMap<MemberID, (SpeedFactor, MemberInfo)>;
pub struct TickManager {
internal_receiver: Receiver<TickCommand>,
/// map of all registered Tick members
member_map: Arc<Mutex<InternalMap>>,
amount_of_members: Arc<AtomicUsize>,
/// time of last main tick
instant: Arc<Mutex<Instant>>,
/// the speed of the global tick
speed: Arc<Speed>,
handle: Option<thread::JoinHandle<()>>,
/// required to send the Shutdown command on drop
global_sender: Sender<TickCommand>,
}
impl TickManager {
pub fn new(speed: Speed) -> (Self, TickManagerHandle) {
let (global_sender, internal_receiver) = flume::bounded(10);
let member_map = Arc::new(Mutex::new(InternalMap::new()));
let mut manager = TickManager {
internal_receiver,
member_map: member_map.clone(),
handle: None,
amount_of_members: Arc::new(AtomicUsize::new(0)),
instant: Arc::new(Mutex::new(Instant::now())),
speed: Arc::new(speed),
global_sender: global_sender.clone(),
};
let handle = TickManagerHandle::new(global_sender);
manager.start();
(manager, handle)
}
pub fn start(&mut self) {
let internal_receiver = self.internal_receiver.clone();
let member_map = self.member_map.clone();
let amount_of_members = self.amount_of_members.clone();
let speed = self.speed.clone();
let instant = self.instant.clone();
self.handle = Some(thread::spawn(move || {
let mut main_tick_counter: usize = 0;
loop {
while let Ok(command) = internal_receiver.try_recv() {
match command {
TickCommand::Register(sender, speed_factor) => {
let mut map = member_map.lock().unwrap();
let id = amount_of_members.fetch_add(1, Ordering::SeqCst);
let _ = sender.send(TickStateReply::SelfID(id));
map.insert(
id,
(
if speed_factor == 0 { 1 } else { speed_factor },
MemberInfo {
sender,
state: MemberState::Running,
last_tick: Instant::now(),
},
),
);
}
TickCommand::ChangeMemberState(member_id, state) => {
let mut map = member_map.lock().unwrap();
if let Some((_sf, member_info)) = map.get_mut(&member_id) {
member_info.state = state;
}
}
TickCommand::Unregister(id) => {
let mut map = member_map.lock().unwrap();
map.remove(&id);
}
TickCommand::Shutdown => {
return;
}
}
}
// determine if a new main frame can be started
{
let mut instant_guard = instant.lock().unwrap();
if speed.new_frame(*instant_guard) {
main_tick_counter = main_tick_counter.wrapping_add(1);
*instant_guard = Instant::now();
let due_members: Vec<MemberID> = {
let map = member_map.lock().unwrap();
map.iter()
.filter_map(|(&member_id, &(sf, _))| {
let sf_nonzero = if sf == 0 { 1 } else { sf };
if main_tick_counter % sf_nonzero == 0 {
Some(member_id)
} else {
None
}
})
.collect()
};
if !due_members.is_empty() {
let all_ready = {
let map = member_map.lock().unwrap();
due_members.iter().all(|&id| {
if let Some((_sf, member_info)) = map.get(&id) {
matches!(
member_info.state,
MemberState::Finished | MemberState::Hidden
)
} else {
true
}
})
};
if all_ready {
let mut senders: Vec<Sender<TickStateReply>> = Vec::new();
{
let mut map = member_map.lock().unwrap();
for id in due_members {
if let Some((_sf, member_info)) = map.get_mut(&id) {
match member_info.state {
MemberState::Finished | MemberState::Hidden => {
member_info.state = MemberState::Running;
member_info.last_tick = Instant::now();
senders.push(member_info.sender.clone());
}
MemberState::Running => {
// shouldn't happen
}
}
}
}
}
for s in senders {
let _ = s.send(TickStateReply::Tick);
}
}
}
}
}
thread::yield_now();
}
}));
}
}
impl Drop for TickManager {
fn drop(&mut self) {
if let Some(handler) = self.handle.take() {
let _ = self.global_sender.send(TickCommand::Shutdown);
let _ = handler.join();
}
}
}