mongoc_stream_read man page

mongoc_stream_read — mongoc_stream_read()

Synopsis

ssize_t
mongoc_stream_read (mongoc_stream_t *stream,
                    void *buf,
                    size_t count,
                    size_t min_bytes,
                    int32_t timeout_msec);

Parameters

The mongoc_stream_read() function shall perform a read from a mongoc_stream_t. It’s modeled on the API and semantics of read(), though the parameters map only loosely.

Returns

The mongoc_stream_read function returns the number of bytes read on success. It returns >= 0 and < min_bytes when end-of-file is encountered and -1 on failure. errno is set upon failure.

See Also

mongoc_stream_readv()

mongoc_stream_write()

mongoc_stream_writev()

Author

MongoDB, Inc

Info

Aug 10, 2017 1.7.0 MongoDB C Driver