s2n-quic-core 0.81.0

Internal crate used by s2n-quic
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
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

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

use crate::{
    transport::parameters::{InitialMaxStreamsBidi, InitialMaxStreamsUni, ValidationError},
    varint::VarInt,
};

/// The default send buffer size for Streams
///
/// This value is based on a common default maximum send buffer size for TCP (net.ipv4.tcp_wmem)
const DEFAULT_STREAM_MAX_SEND_BUFFER_SIZE: u32 = 4096 * 1024;

pub trait LocalLimits {
    fn as_varint(&self) -> VarInt;
}

/// Per-stream limits
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub struct Limits {
    /// The maximum send buffer size for a Stream
    pub max_send_buffer_size: MaxSendBufferSize,
    /// The maximum number of unidirectional streams that may
    /// be opened concurrently by the local endpoint. This value
    /// is not communicated to the peer, it is only used for limiting
    /// concurrent streams opened locally by the application.
    pub max_open_local_unidirectional_streams: LocalUnidirectional,
    /// The maximum number of bidirectional streams that may
    /// be opened concurrently by the local endpoint. This value
    /// is not communicated to the peer, it is only used for limiting
    /// concurrent streams opened locally by the application.
    pub max_open_local_bidirectional_streams: LocalBidirectional,
}

impl Default for Limits {
    fn default() -> Self {
        Self::RECOMMENDED
    }
}

impl Limits {
    pub const RECOMMENDED: Self = Self {
        max_send_buffer_size: MaxSendBufferSize::RECOMMENDED,
        max_open_local_unidirectional_streams: LocalUnidirectional::RECOMMENDED,
        max_open_local_bidirectional_streams: LocalBidirectional::RECOMMENDED,
    };
}

macro_rules! local_limits {
    ($name:ident($encodable_type:ty)) => {
        #[derive(Debug, Copy, Clone, PartialEq, Eq)]
        pub struct $name($encodable_type);
    };
}

// VarInt specific functionality
macro_rules! varint_local_limits {
    ($name:ident($encodable_type:ty)) => {
        local_limits!($name($encodable_type));

        impl LocalLimits for $name {
            #[inline]
            fn as_varint(&self) -> VarInt {
                self.0
            }
        }

        impl TryFrom<u64> for $name {
            type Error = ValidationError;

            #[inline]
            fn try_from(value: u64) -> Result<Self, Self::Error> {
                let value = VarInt::new(value)?;
                Ok(Self(value))
            }
        }
    };
}

local_limits!(MaxSendBufferSize(u32));

impl MaxSendBufferSize {
    pub const RECOMMENDED: Self = Self(DEFAULT_STREAM_MAX_SEND_BUFFER_SIZE);

    #[inline]
    pub fn as_u32(self) -> u32 {
        self.0
    }
}

impl TryFrom<u32> for MaxSendBufferSize {
    type Error = ValidationError;

    #[inline]
    fn try_from(value: u32) -> Result<Self, Self::Error> {
        Ok(Self(value))
    }
}

varint_local_limits!(LocalUnidirectional(VarInt));

impl LocalUnidirectional {
    pub const RECOMMENDED: Self = Self(InitialMaxStreamsUni::RECOMMENDED.as_varint());
}

varint_local_limits!(LocalBidirectional(VarInt));

impl LocalBidirectional {
    pub const RECOMMENDED: Self = Self(InitialMaxStreamsBidi::RECOMMENDED.as_varint());
}

impl From<InitialMaxStreamsBidi> for LocalBidirectional {
    fn from(value: InitialMaxStreamsBidi) -> Self {
        Self(value.as_varint())
    }
}