Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_STREAM_WRITE(3)		   libmongoc		MONGOC_STREAM_WRITE(3)

SYNOPSIS
	  ssize_t
	  mongoc_stream_write (mongoc_stream_t *stream,
			       void *buf,
			       size_t count,
			       int32_t timeout_msec);

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 unspeci-
	  fied 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  mon-
	  goc-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()

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025		MONGOC_STREAM_WRITE(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=mongoc_stream_write&sektion=3&manpath=FreeBSD+Ports+14.3.quarterly>

home | help