.\" Man page generated from reStructuredText.
.
.TH "MONGOC_STREAM_READ" "3" "Jun 04, 2021" "1.17.6" "libmongoc"
.SH NAME
mongoc_stream_read \- mongoc_stream_read()
.
.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
ssize_t
mongoc_stream_read (mongoc_stream_t *stream,
                    void *buf,
                    size_t count,
                    size_t min_bytes,
                    int32_t timeout_msec);
.ft P
.fi
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBstream\fP: A \fBmongoc_stream_t\fP\&.
.IP \(bu 2
\fBbuf\fP: The buffer to read into.
.IP \(bu 2
\fBcount\fP: The number of bytes to read.
.IP \(bu 2
\fBmin_bytes\fP: The minimum number of bytes to read, or else indicate failure.
.IP \(bu 2
\fBtimeout_msec\fP: The number of milliseconds to wait before failure, a timeout of 0 will not block. If negative, use the default timeout.
.UNINDENT
.sp
The \fBmongoc_stream_read()\fP function shall perform a read from a \fBmongoc_stream_t\fP\&. It\(aqs modeled on the API and semantics of \fBread()\fP, though the parameters map only loosely.
.SH RETURNS
.sp
The \fBmongoc_stream_read\fP function returns the number of bytes read on success. It returns \fB>= 0\fP and \fB< min_bytes\fP when end\-of\-file is encountered and \fB\-1\fP on failure. \fBerrno\fP is set upon failure.
.SH SEE ALSO
.sp
\fBmongoc_stream_readv()\fP
.sp
\fBmongoc_stream_write()\fP
.sp
\fBmongoc_stream_writev()\fP
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.