1MONGOC_CHANGE_STREAM_GET_RESUME_TOKElNi(b3mM)oOnNgGoOcC_CHANGE_STREAM_GET_RESUME_TOKEN(3)
2
3
4

SYNOPSIS

6          const bson_t *
7          mongoc_change_stream_get_resume_token (mongoc_change_stream_t *stream);
8
9       This  function  returns the cached resume token, which may be passed as
10       either the resumeAfter or startAfter option  of  a  watch  function  to
11       start a new change stream from the same point.
12

PARAMETERS

14stream: A mongoc_change_stream_t.
15

RETURNS

17       A bson_t that should not be modified or freed.
18
19       Returns  NULL  if no resume token is available. This is possible if the
20       change stream  has  not  been  iterated  and  neither  resumeAfter  nor
21       startAfter options were specified in the watch function.
22

LIFECYCLE

24       The  returned  bson_t  is valid for the lifetime of stream and its data
25       may be updated if  mongoc_change_stream_next()  is  called  after  this
26       function.  The  value  may be copied to extend its lifetime or preserve
27       the current resume token.
28

AUTHOR

30       MongoDB, Inc
31
33       2017-present, MongoDB, Inc
34
35
36
37
381.25.1                           Nov 08M,ON2G0O2C3_CHANGE_STREAM_GET_RESUME_TOKEN(3)
Impressum