Scroll to navigation

MONGOC_STREAM_BUFFERED_NEW(3) libmongoc MONGOC_STREAM_BUFFERED_NEW(3)

SYNOPSIS

mongoc_stream_t *
mongoc_stream_buffered_new (mongoc_stream_t *base_stream, size_t buffer_size);


PARAMETERS

  • base_stream: A mongoc_stream_t <> to buffer.
  • buffer_size: A size_t containing the desired buffer size.

This function shall create a new mongoc_stream_t <> that buffers bytes to and from the underlying base_stream.

buffer_size will be used as the initial buffer size. It may grow past this size.

Warning:

The internal buffer does not reduce in size once grown. Receiving a large message may result in a large allocation that persists until the returned mongoc_stream_t <> is freed with mongoc_stream_destroy() <>.


RETURNS

A newly allocated mongoc_stream_buffered_t <> on success, otherwise NULL. This should be freed with mongoc_stream_destroy() <> when no longer in use.

Author

MongoDB, Inc

Copyright

2009-present, MongoDB, Inc.

December 11, 2025 2.2.1