bionic (3) mongoc_stream_buffered_new.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME

       mongoc_stream_buffered_new - mongoc_stream_buffered_new()

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.

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

       2018, MongoDB, Inc