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

FreeBSD Manual Pages

  
 
  

home | help
MONGOC_STREAM_READV(3)		   libmongoc		MONGOC_STREAM_READV(3)

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

PARAMETERS
        stream: A mongoc_stream_t.

        iov: A	vector of mongoc_iovec_t.

        iovcnt: The number of items in	iov.

        min_bytes: The	minimum	number of bytes	to read	or failure will	be in-
	 dicated.

        timeout_msec:	A timeout in milliseconds, or 0	to indicate non-block-
	 ing. A	negative value with use	the default timeout.

       This function is	identical to mongoc_stream_read() except that it takes
       a mongoc_iovec_t	to perform gathered I/O.

       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
       >= 0 on success,	-1 on failure and errno	is set.

       SEE ALSO:
	  mongoc_stream_read()

	  mongoc_stream_write()

	  mongoc_stream_writev()

AUTHOR
       MongoDB,	Inc

COPYRIGHT
       2009-present, MongoDB, Inc.

1.30.2				 Apr 12, 2025		MONGOC_STREAM_READV(3)

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

home | help