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
|
/*
* ngtcp2
*
* Copyright (c) 2025 ngtcp2 contributors
* Copyright (c) 2023 nghttp2 contributors
*
* Permission is hereby granted, free of charge, to any person obtaining
* a copy of this software and associated documentation files (the
* "Software"), to deal in the Software without restriction, including
* without limitation the rights to use, copy, modify, merge, publish,
* distribute, sublicense, and/or sell copies of the Software, and to
* permit persons to whom the Software is furnished to do so, subject to
* the following conditions:
*
* The above copyright notice and this permission notice shall be
* included in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
* LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
* WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
#ifndef NGTCP2_RATELIM_H
#define NGTCP2_RATELIM_H
#ifdef HAVE_CONFIG_H
# include <config.h>
#endif /* defined(HAVE_CONFIG_H) */
#include <ngtcp2/ngtcp2.h>
typedef struct ngtcp2_ratelim {
/* burst is the maximum number of tokens. */
uint64_t burst;
/* rate is the rate of token generation measured by token /
second. */
uint64_t rate;
/* tokens is the amount of tokens available to drain. */
uint64_t tokens;
/* carry is the partial token gained in sub-second period. It is
added to the computation in the next update round. */
uint64_t carry;
/* ts is the last timestamp that is known to this object. */
ngtcp2_tstamp ts;
} ngtcp2_ratelim;
/* ngtcp2_ratelim_init initializes |rlim| with the given
parameters. */
void ngtcp2_ratelim_init(ngtcp2_ratelim *rlim, uint64_t burst, uint64_t rate,
ngtcp2_tstamp ts);
/* ngtcp2_ratelim_drain drains |n| from rlim->tokens. It returns 0 if
it succeeds, or -1. */
int ngtcp2_ratelim_drain(ngtcp2_ratelim *rlim, uint64_t n, ngtcp2_tstamp ts);
#endif /* !defined(NGTCP2_RATELIM_H) */
|
