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

/*
 * Copyright 2021 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#[cfg(doc)]
use crate::filters::Filter;
use crate::net::{
    ClusterMap,
    endpoint::{EndpointAddress, metadata::DynamicMetadata},
};

/// The input arguments to [`Filter::read`].
pub struct ReadContext<'ctx, P> {
    /// The upstream endpoints that the packet will be forwarded to.
    pub endpoints: &'ctx ClusterMap,
    /// The upstream endpoints that the packet will be forwarded to.
    pub destinations: &'ctx mut Vec<EndpointAddress>,
    /// The source of the received packet.
    pub source: EndpointAddress,
    /// Contents of the received packet.
    pub contents: P,
    /// Arbitrary values that can be passed from one filter to another.
    pub metadata: DynamicMetadata,
}

impl<'ctx, P: super::PacketMut> ReadContext<'ctx, P> {
    /// Creates a new [`ReadContext`].
    #[inline]
    pub fn new(
        endpoints: &'ctx ClusterMap,
        source: EndpointAddress,
        contents: P,
        destinations: &'ctx mut Vec<EndpointAddress>,
    ) -> Self {
        Self {
            endpoints,
            destinations,
            source,
            contents,
            metadata: <_>::default(),
        }
    }
}