mongoc_stream_write3
Parameters
- •
-
stream: A mongoc_stream_t.
- •
-
buf: The buffer to write.
- •
-
count: The number of bytes to write.
- •
-
timeout_msec: The number of milliseconds to wait before failure, a timeout of 0 will not block. If negative, use the default timeout.
The mongoc_stream_write() function shall perform a write to a mongoc_stream_t. It's modeled on the API and semantics of write(), though the parameters map only loosely.
WARNING:
The "default timeout" indicated by a negative value is both unspecified and unrelated to the documented default values for *TimeoutMS URI options. To specify a default timeout value for a *TimeoutMS URI option, use the MONGOC_DEFAULT_* constants defined in mongoc-client.h.
Returns
The mongoc_stream_write() function returns the number of bytes written on success. It returns -1 and sets errno upon failure.
SEE ALSO:
mongoc_stream_read()
mongoc_stream_readv()
mongoc_stream_writev()
History
- Debian 13 (Trixie): the text shown here
- Debian 12 (Bookworm)
- Debian 11 (Bullseye)
- Debian 10 (Buster)
- Debian 9 (Stretch)