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

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_STREAM_WRITEV(3)		   libmongoc	       MONGOC_STREAM_WRITEV(3)

SYNOPSIS
	  ssize_t
	  mongoc_stream_writev (mongoc_stream_t	*stream,
				mongoc_iovec_t *iov,
				size_t iovcnt,
				int32_t	timeout_msec);

PARAMETERS
        stream: A mongoc_stream_t.

        iov: A	vector of mongoc_iovec_t.

        iovcnt: The number of items in	iov.

        timeout_msec:	The  number of milliseconds to block before indicating
	 failure, or 0 for non-blocking. Negative values indicate the  default
	 timeout.

       The   mongoc_stream_writev()  function  shall  perform  a  write	 to  a
       mongoc_stream_t.	It's modeled on	the API	 and  semantics	 of  writev(),
       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 number of bytes written on success, or -1 upon failure and errno is
       set.

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025	       MONGOC_STREAM_WRITEV(3)

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

home | help