1 /*
2  * nghttp3
3  *
4  * Copyright (c) 2019 nghttp3 contributors
5  * Copyright (c) 2017 ngtcp2 contributors
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining
8  * a copy of this software and associated documentation files (the
9  * "Software"), to deal in the Software without restriction, including
10  * without limitation the rights to use, copy, modify, merge, publish,
11  * distribute, sublicense, and/or sell copies of the Software, and to
12  * permit persons to whom the Software is furnished to do so, subject to
13  * the following conditions:
14  *
15  * The above copyright notice and this permission notice shall be
16  * included in all copies or substantial portions of the Software.
17  *
18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
19  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
21  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
22  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
24  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25  */
26 #ifndef NGHTTP3_BUF_H
27 #define NGHTTP3_BUF_H
28 
29 #ifdef HAVE_CONFIG_H
30 #  include <config.h>
31 #endif /* HAVE_CONFIG_H */
32 
33 #include <nghttp3/nghttp3.h>
34 
35 #include "nghttp3_mem.h"
36 
37 void nghttp3_buf_wrap_init(nghttp3_buf *buf, uint8_t *src, size_t len);
38 
39 /*
40  * nghttp3_buf_cap returns the capacity of the buffer.  In other
41  * words, it returns buf->end - buf->begin.
42  */
43 size_t nghttp3_buf_cap(const nghttp3_buf *buf);
44 
45 int nghttp3_buf_reserve(nghttp3_buf *buf, size_t size, const nghttp3_mem *mem);
46 
47 /*
48  * nghttp3_buf_swap swaps |a| and |b|.
49  */
50 void nghttp3_buf_swap(nghttp3_buf *a, nghttp3_buf *b);
51 
52 typedef enum nghttp3_buf_type {
53   /* NGHTTP3_BUF_TYPE_PRIVATE indicates that memory is allocated for
54      this buffer only and should be freed after its use. */
55   NGHTTP3_BUF_TYPE_PRIVATE,
56   /* NGHTTP3_BUF_TYPE_SHARED indicates that buffer points to shared
57      memory. */
58   NGHTTP3_BUF_TYPE_SHARED,
59   /* NGHTTP3_BUF_TYPE_ALIEN indicates that the buffer points to a
60      memory which comes from outside of the library. */
61   NGHTTP3_BUF_TYPE_ALIEN,
62 } nghttp3_buf_type;
63 
64 typedef struct nghttp3_typed_buf {
65   nghttp3_buf buf;
66   nghttp3_buf_type type;
67 } nghttp3_typed_buf;
68 
69 void nghttp3_typed_buf_init(nghttp3_typed_buf *tbuf, const nghttp3_buf *buf,
70                             nghttp3_buf_type type);
71 
72 void nghttp3_typed_buf_free(nghttp3_typed_buf *tbuf);
73 
74 #endif /* NGHTTP3_BUF_H */
75