.\" Man page generated from reStructuredText.
.
.TH "MONGOC_STREAM_BUFFERED_NEW" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_stream_buffered_new \- mongoc_stream_buffered_new()
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
mongoc_stream_t *
mongoc_stream_buffered_new (mongoc_stream_t *base_stream, size_t buffer_size);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBbase_stream\fP: A \fBmongoc_stream_t\fP to buffer.
.IP \(bu 2
\fBbuffer_size\fP: A size_t containing the desired buffer size.
.UNINDENT
.sp
This function shall create a new \fBmongoc_stream_t\fP that buffers bytes to and from the underlying \fBbase_stream\fP\&.
.sp
\fBbuffer_size\fP will be used as the initial buffer size. It may grow past this size.
.SH RETURNS
.sp
A newly allocated \fBmongoc_stream_buffered_t\fP on success, otherwise \fBNULL\fP\&. This should be freed with \fBmongoc_stream_destroy()\fP when no longer in use.
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.