d5/d06/gnunet__buffer__lib_8h_source.html

/*

     This file is part of GNUnet.

     Copyright (C) 2020 GNUnet e.V.


     GNUnet is free software: you can redistribute it and/or modify it

     under the terms of the GNU Affero General Public License as published

     by the Free Software Foundation, either version 3 of the License,

     or (at your option) any later version.


     GNUnet is distributed in the hope that it will be useful, but

     WITHOUT ANY WARRANTY; without even the implied warranty of

     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

     Affero General Public License for more details.


     You should have received a copy of the GNU Affero General Public License

     along with this program.  If not, see <http://www.gnu.org/licenses/>.


     SPDX-License-Identifier: AGPL3.0-or-later

 */


#if ! defined (__GNUNET_UTIL_LIB_H_INSIDE__)

#error "Only <gnunet_util_lib.h> can be included directly."

#endif


#ifndef GNUNET_BUFFER_LIB_H

#define GNUNET_BUFFER_LIB_H


struct GNUNET_Buffer

{

  size_t capacity;


  size_t position;


  char *mem;


  int warn_grow;

};


void

GNUNET_buffer_prealloc (struct GNUNET_Buffer *buf,

                        size_t capacity);


void

GNUNET_buffer_large (struct GNUNET_Buffer *buf);


void

GNUNET_buffer_ensure_remaining (struct GNUNET_Buffer *buf,

                                size_t n);


void

GNUNET_buffer_write (struct GNUNET_Buffer *buf,

                     const char *data,

                     size_t len);


void

GNUNET_buffer_write_str (struct GNUNET_Buffer *buf,

                         const char *str);


void

GNUNET_buffer_write_data_encoded (struct GNUNET_Buffer *buf,

                                  const void *data,

                                  size_t data_len);


void

GNUNET_buffer_write_path (struct GNUNET_Buffer *buf,

                          const char *str);


void

GNUNET_buffer_write_fstr (struct GNUNET_Buffer *buf,

                          const char *fmt,

                          ...)

__attribute__ ((format (printf, 2, 3)));


void

GNUNET_buffer_write_vfstr (struct GNUNET_Buffer *buf,

                           const char *fmt,

                           va_list args);


char *

GNUNET_buffer_reap_str (struct GNUNET_Buffer *buf);


void *

GNUNET_buffer_reap (struct GNUNET_Buffer *buf,

                    size_t *size);


void

GNUNET_buffer_clear (struct GNUNET_Buffer *buf);


#endif


 /* 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:89

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:201

GNUNET_buffer_large
void GNUNET_buffer_large(struct GNUNET_Buffer *buf)
Informs the buffer library to expect this buffer to be potentially very large (exceeding GNUNET_mallo...

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:40

GNUNET_buffer_reap
void * GNUNET_buffer_reap(struct GNUNET_Buffer *buf, size_t *size)
Clear the buffer and return its contents.
Definition buffer.c:109

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:169

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:63

GNUNET_buffer_prealloc
void GNUNET_buffer_prealloc(struct GNUNET_Buffer *buf, size_t capacity)
Initialize a buffer with the given capacity.
Definition buffer.c:26

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:133

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:77

GNUNET_buffer_clear
void GNUNET_buffer_clear(struct GNUNET_Buffer *buf)
Free the backing memory of the given buffer.
Definition buffer.c:123

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

str
const char * str
Definition time.c:1252