.\" This manpage is Copyright (C) 2016 MongoDB, Inc.
.\" 
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.3
.\" or any later version published by the Free Software Foundation;
.\" with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
.\" A copy of the license is included in the section entitled "GNU
.\" Free Documentation License".
.\" 
.TH "MONGOC_STREAM_BUFFERED_NEW" "3" "2016\(hy10\(hy12" "MongoDB C Driver"
.SH NAME
mongoc_stream_buffered_new() \- This function shall create a new mongoc_stream_t that buffers bytes to and from the underlying base_stream.
.SH "SYNOPSIS"

.nf
.nf
mongoc_stream_t *
mongoc_stream_buffered_new (mongoc_stream_t *base_stream,
                            size_t           buffer_size);
.fi
.fi

.SH "PARAMETERS"

.TP
.B
base_stream
A
.B mongoc_stream_t
to buffer.
.LP
.TP
.B
buffer_size
A size_t containing the desired buffer size.
.LP

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

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

.SH "RETURNS"

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


.B
.SH COLOPHON
This page is part of MongoDB C Driver.
Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.