quilkin 0.10.0

Quilkin is a non-transparent UDP proxy specifically designed for use with large scale multiplayer dedicated game server deployments, to ensure security, access control, telemetry data, metrics and more.
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

use std::fmt::Debug;

use super::{Cmrdt, Dot, VClock};

/// `ReadCtx`'s are used to extract data from CRDT's while maintaining some causal history.
/// You should store `ReadCtx`'s close to where mutation is exposed to the user.
#[derive(Debug, PartialEq, Eq)]
pub struct ReadCtx<V, A: Ord> {
    /// clock used to derive an [`AddCtx`]
    pub add_clock: VClock<A>,

    /// clock used to derive an [`RmCtx`]
    pub rm_clock: VClock<A>,

    /// the data read from the CRDT
    pub val: V,
}

/// [`AddCtx`] is used for mutations that add new information to a CRDT
#[derive(Debug)]
pub struct AddCtx<A: Ord> {
    /// The adding vclock context
    pub clock: VClock<A>,

    /// The Actor and the Actor's version at the time of the add
    pub dot: Dot<A>,
}

/// [`RmCtx`] is used for mutations that remove information from a CRDT
#[derive(Debug, Clone)]
pub struct RmCtx<A: Ord> {
    /// The removing vclock context
    pub clock: VClock<A>,
}

impl<V, A: Ord + Clone + Debug> ReadCtx<V, A> {
    /// Derives an [`AddCtx`] for a given actor from a [`Self`]
    #[inline]
    pub fn derive_add_ctx(self, actor: A) -> AddCtx<A> {
        let mut clock = self.add_clock;
        let dot = clock.inc(actor);
        clock.apply(dot.clone());
        AddCtx { clock, dot }
    }

    /// Derives a [`RmCtx`] from a [`Self`]
    #[inline]
    pub fn derive_rm_ctx(self) -> RmCtx<A> {
        RmCtx {
            clock: self.rm_clock,
        }
    }

    /// Splits this [`ReadCtx`] into its data and an empty [`ReadCtx`]
    #[inline]
    pub fn split(self) -> (V, ReadCtx<(), A>) {
        (
            self.val,
            ReadCtx {
                add_clock: self.add_clock,
                rm_clock: self.rm_clock,
                val: (),
            },
        )
    }
}