tick_manager_rs 0.1.0

A tick manager for synchronizing ticks across multiple members with different tick rates.
Documentation 
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

use flume::Sender;

use crate::{HookID, MemberID, MemberState, TickStateReply};

/// commands that can be sent to the TickManager
pub enum TickCommand {
    // register a new member to the TickManager
    // needs a speed factor
    Register(Sender<TickStateReply>, usize),
    //remove a member from the TickManager
    Unregister(HookID),

    ChangeMemberState(MemberID, MemberState),

    // shutdown the Tick Manager
    Shutdown,
}

/// this struct will be given to other threads, so they can create new Tick Hooks
#[derive(Debug, Clone)]
pub struct TickManagerHandle {
    global_sender: Sender<TickCommand>,
}

impl TickManagerHandle {
    pub fn new(global_sender: Sender<TickCommand>) -> Self {
        TickManagerHandle { global_sender }
    }
    /// sends a message to the Tick Manager
    pub fn send(&self, command: TickCommand) -> Result<(), flume::SendError<TickCommand>> {
        self.global_sender.send(command)
    }
}