twilight_gateway_queue/
lib.rs

1#![doc = include_str!("../README.md")]
2#![warn(
3    clippy::missing_const_for_fn,
4    clippy::missing_docs_in_private_items,
5    clippy::pedantic,
6    missing_docs,
7    unsafe_code
8)]
9#![allow(clippy::module_name_repetitions, clippy::must_use_candidate)]
10
11mod in_memory;
12
13pub use in_memory::InMemoryQueue;
14
15use tokio::{sync::oneshot, time::Duration};
16
17/// Period between buckets.
18pub const IDENTIFY_DELAY: Duration = Duration::from_secs(5);
19
20/// Duration from the first identify until the remaining count resets to the
21/// total count.
22pub const LIMIT_PERIOD: Duration = Duration::from_secs(60 * 60 * 24);
23
24/// Abstraction for types processing gateway identify requests.
25pub trait Queue {
26    /// Enqueue a shard with this ID.
27    ///
28    /// Send `()` to signal the shard to proceed. Note that shards may have
29    /// dropped the receiver prior.
30    ///
31    /// Closing the channel should causes the shard to requeue.
32    fn enqueue(&self, id: u32) -> oneshot::Receiver<()>;
33}
34
35impl<T> Queue for &T
36where
37    T: Queue,
38{
39    fn enqueue(&self, shard: u32) -> oneshot::Receiver<()> {
40        (**self).enqueue(shard)
41    }
42}
43
44#[cfg(test)]
45mod tests {
46    use super::Queue;
47    use static_assertions::assert_obj_safe;
48
49    assert_obj_safe!(Queue);
50}
twilight_gateway_queue/lib.rs

twilight_gateway_queue/
lib.rs
