1MONGOC_CHANGE_STREAM_NEXT(3)   MongoDB C Driver   MONGOC_CHANGE_STREAM_NEXT(3)
2
3
4

NAME

6       mongoc_change_stream_next - mongoc_change_stream_next()
7

SYNOPSIS

9          bool
10          mongoc_change_stream_next (mongoc_change_stream_t *stream,
11                                     const bson_t **bson);
12
13       This  function iterates the underlying cursor, setting bson to the next
14       document. This will block for a maximum of maxAwaitTimeMS  milliseconds
15       as  specified  in  the  options when created, or the default timeout if
16       omitted. Data may be  returned  before  the  timeout.  If  no  data  is
17       returned this function returns false.
18

PARAMETERS

20       · stream:   A   mongoc_change_stream_t   obtained  from  mongoc_collec‐
21         tion_watch.
22
23       · bson: The location for the resulting document.
24

RETURNS

26       A boolean indicating whether or not there was another document  in  the
27       stream.
28
29       Similar  to  mongoc_cursor_next  the lifetime of bson is until the next
30       call to mongoc_change_stream_next, so it needs to be copied  to  extend
31       the lifetime.
32

AUTHOR

34       MongoDB, Inc
35

37       2017-present, MongoDB, Inc
38
39
40
41
421.14.0                           Feb 22, 2019     MONGOC_CHANGE_STREAM_NEXT(3)
Impressum