bionic (3) mongoc_change_stream_next.3.gz

Provided by: libmongoc-doc_1.9.2+dfsg-1build1_all bug

NAME
       mongoc_change_stream_next - mongoc_change_stream_next()


SYNOPSIS
          bool
          mongoc_change_stream_next (mongoc_change_stream_t *stream,
                                     const bson_t **bson);

       This  function  iterates  the underlying cursor, setting bson to the next document. This will block for a
       maximum of maxAwaitTimeMS milliseconds as specified in the options when created, or the  default  timeout
       if omitted. Data may be returned before the timeout. If no data is returned this function returns false.


PARAMETERS
       • stream: A mongoc_change_stream_t obtained from mongoc_collection_watch.

       • bson: The location for the resulting document.


RETURNS
       A boolean indicating whether or not there was another document in the stream.

       Similar  to  mongoc_cursor_next the lifetime of bson is until the next call to mongoc_change_stream_next,
       so it needs to be copied to extend the lifetime.


AUTHOR
       MongoDB, Inc


       2018, MongoDB, Inc