1MONGOC_CHANGE_STREAM_GET_RESUME_TOKElNi(b3mM)oOnNgGoOcC_CHANGE_STREAM_GET_RESUME_TOKEN(3)
2
3
4
6 mongoc_change_stream_get_resume_token - mongoc_change_stream_get_re‐
7 sume_token()
8
10 const bson_t *
11 mongoc_change_stream_get_resume_token (mongoc_change_stream_t *stream);
12
13 This function returns the cached resume token, which may be passed as
14 either the resumeAfter or startAfter option of a watch function to
15 start a new change stream from the same point.
16
18 • stream: A mongoc_change_stream_t.
19
21 A bson_t that should not be modified or freed.
22
23 Returns NULL if no resume token is available. This is possible if the
24 change stream has not been iterated and neither resumeAfter nor
25 startAfter options were specified in the watch function.
26
28 The returned bson_t is valid for the lifetime of stream and its data
29 may be updated if mongoc_change_stream_next is called after this func‐
30 tion. The value may be copied to extend its lifetime or preserve the
31 current resume token.
32
34 MongoDB, Inc
35
37 2017-present, MongoDB, Inc
38
39
40
41
421.20.0 Nov 18M,ON2G0O2C1_CHANGE_STREAM_GET_RESUME_TOKEN(3)