bson_realloc (3) - Linux Manuals

bson_realloc: This is a portable realloc() wrapper.

NAME

bson_realloc() - This is a portable realloc() wrapper.

SYNOPSIS

void *
bson_realloc (void  *mem,
              size_t num_bytes);

PARAMETERS

mem
A memory region.

num_bytes
A size_t containing the new requested size.

DESCRIPTION

This is a portable realloc(3) wrapper.

In general, this function will return an allocation at least sizeof(void*) bytes or bigger. If num_bytes is 0, then the allocation will be freed.

If there was a failure to allocate num_bytes bytes, the process will be aborted.

NOTE

This function will abort on failure to allocate memory.

RETURNS

A pointer to a memory region which HAS NOT been zeroed.

COLOPHON

This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Pages related to bson_realloc

  • bson_realloc_ctx (3) - This function is identical to bson_realloc() except it takes a context parameter. This is useful when working with pooled or specific memory allocators.
  • bson_realloc_func (3) - This is a prototype for pluggable realloc functions used through the Libbson library. If you wish to use a custom allocator this is one way to do it. Additionally, bson_realloc_ctx() is a default implementation of this prototype.
  • bson_reader_destroy (3) - Destroys and releases all resources associated with reader.
  • bson_reader_destroy_func_t (3) - An optional callback function that will be called when a bson_reader_t created with bson_reader_new_from_handle is destroyed with bson_reader_destroy().
  • bson_reader_new_from_data (3) - The bson_reader_new_from_data() function shall create a new bson_reader_t using the buffer supplied. data is not copied and MUST be valid for the lifetime of the resulting bson_reader_t.
  • bson_reader_new_from_fd (3) - The bson_reader_new_from_fd() function shall create a new bson_reader_t that will read from the provided file-descriptor.
  • bson_reader_new_from_file (3) - Creates a new bson_reader_t using the file denoted by filename.
  • bson_reader_new_from_handle (3) - This function allows for a pluggable data stream for the reader. This can be used to read from sockets, files, memory, or other arbitrary sources.
  • bson_reader_read (3) - The bson_reader_read() function shall read the next document from the underlying file-descriptor or buffer.
  • bson_reader_read_func_t (3) - A callback function that will be called by bson_reader_t to read the next chunk of data from the underlying opaque file descriptor.
  • bson_reader_set_destroy_func (3) - Allows for setting a callback to be executed when a reader is destroyed. This should only be used by implementations implementing their own read callbacks.
  • bson_reader_set_read_func (3) - Sets the function to read more data from the underlying stream in a custom bson_reader_t.