Section 3: library functions
NAME btree – btree database access method SYNOPSIS #include <db.h> #include <sys/types.h> DESCRIPTION Note well: This page documents interfaces provided in glibc up until version 2.1. Since version 2.2, glibc no longer provides these interfaces. Probably, you are looking for the APIs provided by the libdb library instead. The routine dbopen(3) is the library interface…
NAME btowc – convert single byte to wide character SYNOPSIS #include <wchar.h> wint_t btowc(int c); DESCRIPTION The btowc() function converts c, interpreted as a multibyte sequence of length 1, starting in the initial shift state, to a wide character and returns it. If c is EOF or not a valid multibyte sequence of length 1,…
NAME bswap_16, bswap_32, bswap_64 – reverse order of bytes SYNOPSIS #include <byteswap.h> bswap_16(x); bswap_32(x); bswap_64(x); DESCRIPTION These macros return a value in which the order of the bytes in their 2-, 4-, or 8-byte arguments is reversed. RETURN VALUE These macros return the value of their argument with the bytes reversed. ERRORS These macros always…
NAME bswap_16, bswap_32, bswap_64 – reverse order of bytes SYNOPSIS #include <byteswap.h> bswap_16(x); bswap_32(x); bswap_64(x); DESCRIPTION These macros return a value in which the order of the bytes in their 2-, 4-, or 8-byte arguments is reversed. RETURN VALUE These macros return the value of their argument with the bytes reversed. ERRORS These macros always…
NAME bswap_16, bswap_32, bswap_64 – reverse order of bytes SYNOPSIS #include <byteswap.h> bswap_16(x); bswap_32(x); bswap_64(x); DESCRIPTION These macros return a value in which the order of the bytes in their 2-, 4-, or 8-byte arguments is reversed. RETURN VALUE These macros return the value of their argument with the bytes reversed. ERRORS These macros always…
NAME bswap_16, bswap_32, bswap_64 – reverse order of bytes SYNOPSIS #include <byteswap.h> bswap_16(x); bswap_32(x); bswap_64(x); DESCRIPTION These macros return a value in which the order of the bytes in their 2-, 4-, or 8-byte arguments is reversed. RETURN VALUE These macros return the value of their argument with the bytes reversed. ERRORS These macros always…
NAME bcmp, bcopy, bzero, memccpy, memchr, memcmp, memcpy, memfrob, memmem, memmove, memset – byte string operations SYNOPSIS #include <string.h> int bcmp(const void *s1, const void *s2, size_t n); void bcopy(const void *src, void *dest, size_t n); void bzero(void *s, size_t n); void *memccpy(void *dest, const void *src, int c, size_t n); void *memchr(const void *s,…
NAME bson_zero_free() – This function behaves like bson_free() except that it zeroes the memory first. This can be useful if you are storing passwords or other similarly important data. Note that if it truly is important, you probably want a page protected with mlock() as well to prevent it swapping to disk. SYNOPSIS void bson_zero_free(void…
NAME bson_writer_t – Bulk BSON serialization Abstraction SYNOPSIS #include <bson.h> typedef struct _bson_writer_t bson_writer_t; bson_writer_t *bson_writer_new(uint8_t **buf, size_t *buflen, size_t offset, bson_realloc_func realloc_func, void *realloc_func_ctx); void bson_writer_destroy(bson_writer_t *writer); DESCRIPTION The bson_writer_t API provides an abstraction for serializing many BSON documents to a single memory region. The memory region may be dynamically allocated and re-allocated as…
NAME bson_writer_rollback() – Abort the appending of the current bson_t to the memory region managed by writer. This is useful if you detected that you went past a particular memory limit. For example, MongoDB has 48MB message limits. SYNOPSIS void bson_writer_rollback(bson_writer_t *writer); PARAMETERS writer A bson_writer_t \&. DESCRIPTION Abort the appending of the current bson_t…
NAME bson_writer_new() – Creates a new instance of bson_writer_t using the buffer, length, offset, and _realloc()_ function supplied. SYNOPSIS bson_writer_t * bson_writer_new (uint8_t **buf, size_t *buflen, size_t offset, bson_realloc_func realloc_func, void *realloc_func_ctx); PARAMETERS buf A uint8_t. buflen A size_t. offset A size_t. realloc_func A bson_realloc_func. realloc_func_ctx A bson_realloc_func. DESCRIPTION Creates a new instance of bson_writer_t…
NAME bson_writer_get_length() – Fetches the current length of the content written by the buffer (including the initial offset). This includes a partly written document currently being written. SYNOPSIS size_t bson_writer_get_length (bson_writer_t *writer); PARAMETERS writer A bson_writer_t \&. DESCRIPTION Fetches the current length of the content written by the buffer (including the initial offset). This includes…
NAME bson_writer_end() – Complete writing of a bson_writer_t to the buffer supplied. SYNOPSIS void bson_writer_end(bson_writer_t *writer); PARAMETERS writer A bson_writer_t \&. DESCRIPTION Complete writing of a bson_writer_t to the buffer supplied. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_writer_destroy() – Cleanup after writer and release any allocated memory. Note that the buffer supplied to bson_writer_new() is NOT freed from this method. The caller is responsible for that. SYNOPSIS void bson_writer_destroy(bson_writer_t *writer); PARAMETERS writer A bson_writer_t \&. DESCRIPTION Cleanup after writer and release any allocated memory. Note that the buffer supplied to bson_writer_new(3)…
NAME bson_writer_begin() – Begins writing a new document. The caller may use the bson structure to write out a new BSON document. When completed, the caller must call either bson_writer_end() or bson_writer_rollback(). SYNOPSIS bool bson_writer_begin (bson_writer_t *writer, bson_t **bson); PARAMETERS writer A bson_writer_t \&. bson A bson_t \&. DESCRIPTION Begins writing a new document. The…
NAME bson_vsnprintf() – Like bson_snprintf() but allows for variadic parameters. SYNOPSIS int bson_vsnprintf(char *str, size_t size, const char *format, va_list ap) BSON_GNUC_PRINTF(3, 0); PARAMETERS str A location for the resulting string. size The size of str in bytes. format A printf style format string. ap A va_list of parameters for the format. DESCRIPTION Like bson_snprintf()…
NAME bson_visitor_t – The bson_visitor_t structure provides a series of callbacks that can be called while iterating a BSON document. This may simplify the conversion of a bson_t to a higher level language structure. SYNOPSIS #include <bson.h> typedef struct { bool (*visit_before)(const bson_iter_t *iter, const char *key, void *data); bool (*visit_after)(const bson_iter_t *iter, const char…
NAME bson_value_t – BSON Boxed Container Type SYNOPSIS #include <bson.h> typedef struct _bson_value_t { bson_type_t value_type; union { bson_oid_t v_oid; int64_t v_int64; int32_t v_int32; int8_t v_int8; double v_double; bool v_bool; int64_t v_datetime; struct { uint32_t timestamp; uint32_t increment; } v_timestamp; struct { uint32_t len; char *str; } v_utf8; struct { uint32_t data_len; uint8_t *data; }…
NAME bson_value_destroy() – Releases any resources associated with value. SYNOPSIS void bson_value_destroy(bson_value_t *value); PARAMETERS value A bson_value_t \&. DESCRIPTION Releases any resources associated with value \&. COLOPHON This page is part of libbson. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER. Index
NAME bson_value_copy() – This function will copy the boxed content in src into dst. dst must be freed with bson_value_destroy() when no longer in use. SYNOPSIS void bson_value_copy(const bson_value_t *src, bson_value_t *dst); PARAMETERS src A bson_value_t to copy from. dst A bson_value_t to copy into. DESCRIPTION This function will copy the boxed content in src…