GNUnet 0.21.1
gnunet_buffer_lib.h
Go to the documentation of this file.
1/*
2 This file is part of GNUnet.
3 Copyright (C) 2020 GNUnet e.V.
4
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
9
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
14
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
17
18 SPDX-License-Identifier: AGPL3.0-or-later
19 */
20
31#if !defined (__GNUNET_UTIL_LIB_H_INSIDE__)
32#error "Only <gnunet_util_lib.h> can be included directly."
33#endif
34
35#ifndef GNUNET_BUFFER_LIB_H
36#define GNUNET_BUFFER_LIB_H
37
47struct GNUNET_Buffer
48{
52 size_t capacity;
53
57 size_t position;
58
62 char *mem;
63
67 int warn_grow;
68};
69
70
80void
81GNUNET_buffer_prealloc (struct GNUNET_Buffer *buf, size_t capacity);
82
83
90void
91GNUNET_buffer_ensure_remaining (struct GNUNET_Buffer *buf, size_t n);
92
93
104void
105GNUNET_buffer_write (struct GNUNET_Buffer *buf, const char *data, size_t len);
106
107
116void
117GNUNET_buffer_write_str (struct GNUNET_Buffer *buf, const char *str);
118
119
129void
130GNUNET_buffer_write_data_encoded (struct GNUNET_Buffer *buf,
131 const void *data,
132 size_t data_len);
133
134
143void
144GNUNET_buffer_write_path (struct GNUNET_Buffer *buf, const char *str);
145
146
157void
158GNUNET_buffer_write_fstr (struct GNUNET_Buffer *buf, const char *fmt, ...)
159__attribute__ ((format (printf, 2, 3)));
160
161
172void
173GNUNET_buffer_write_vfstr (struct GNUNET_Buffer *buf, const char *fmt, va_list
174 args);
175
176
187char *
188GNUNET_buffer_reap_str (struct GNUNET_Buffer *buf);
189
190
200void *
201GNUNET_buffer_reap (struct GNUNET_Buffer *buf, size_t *size);
202
203
209void
210GNUNET_buffer_clear (struct GNUNET_Buffer *buf);
211
212
213#endif
214 /* end of group addition */
data
static char * data
The data to insert into the dht.
Definition: gnunet-dht-put.c:88
__attribute__
struct GNUNET_PQ_ResultSpec __attribute__
GNUNET_buffer_reap_str
char * GNUNET_buffer_reap_str(struct GNUNET_Buffer *buf)
Clear the buffer and return the string it contained.
Definition: buffer.c:123
GNUNET_buffer_write_data_encoded
void GNUNET_buffer_write_data_encoded(struct GNUNET_Buffer *buf, const void *data, size_t data_len)
Write data encoded via GNUNET_STRINGS_data_to_string to the buffer.
Definition: buffer.c:264
GNUNET_buffer_ensure_remaining
void GNUNET_buffer_ensure_remaining(struct GNUNET_Buffer *buf, size_t n)
Make sure that at least n bytes remaining in the buffer.
Definition: buffer.c:55
GNUNET_buffer_reap
void * GNUNET_buffer_reap(struct GNUNET_Buffer *buf, size_t *size)
Clear the buffer and return its contents.
Definition: buffer.c:149
GNUNET_buffer_write_fstr
void GNUNET_buffer_write_fstr(struct GNUNET_Buffer *buf, const char *fmt,...) __attribute__((format(printf
Write a 0-terminated formatted string to a buffer, excluding the 0-terminator.
GNUNET_buffer_write_vfstr
void void GNUNET_buffer_write_vfstr(struct GNUNET_Buffer *buf, const char *fmt, va_list args)
Write a 0-terminated formatted string to a buffer, excluding the 0-terminator.
Definition: buffer.c:230
GNUNET_buffer_write
void GNUNET_buffer_write(struct GNUNET_Buffer *buf, const char *data, size_t len)
Write bytes to the buffer.
Definition: buffer.c:86
GNUNET_buffer_prealloc
void GNUNET_buffer_prealloc(struct GNUNET_Buffer *buf, size_t capacity)
Initialize a buffer with the given capacity.
Definition: buffer.c:35
GNUNET_buffer_write_path
void GNUNET_buffer_write_path(struct GNUNET_Buffer *buf, const char *str)
Write a path component to a buffer, ensuring that there is exactly one slash between the previous con...
Definition: buffer.c:180
GNUNET_buffer_write_str
void GNUNET_buffer_write_str(struct GNUNET_Buffer *buf, const char *str)
Write a 0-terminated string to a buffer, excluding the 0-terminator.
Definition: buffer.c:103
GNUNET_buffer_clear
void GNUNET_buffer_clear(struct GNUNET_Buffer *buf)
Free the backing memory of the given buffer.
Definition: buffer.c:164
size
static unsigned int size
Size of the "table".
Definition: peer.c:68
GNUNET_Buffer
Dynamically growing buffer.
Definition: gnunet_buffer_lib.h:48
GNUNET_Buffer::capacity
size_t capacity
Capacity of the buffer.
Definition: gnunet_buffer_lib.h:52
GNUNET_Buffer::warn_grow
int warn_grow
Log a warning if the buffer is grown over its initially allocated capacity.
Definition: gnunet_buffer_lib.h:67
GNUNET_Buffer::position
size_t position
Current write position.
Definition: gnunet_buffer_lib.h:57
GNUNET_Buffer::mem
char * mem
Backing memory.
Definition: gnunet_buffer_lib.h:62