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

  
 
  

home | help
MONGOC_CHANGE...T_RESUME_TOKEN(3)   libmongoc  MONGOC_CHANGE...T_RESUME_TOKEN(3)

SYNOPSIS
	const bson_t *
	mongoc_change_stream_get_resume_token (mongoc_change_stream_t *stream);

     This  function  returns the cached resume token, which may be passed as ei-
     ther the resumeAfter or startAfter option of a watch function  to	start  a
     new change stream from the same point.

PARAMETERS
     * stream: A mongoc_change_stream_t.

RETURNS
     A bson_t that should not be modified or freed.

     Returns  NULL  if	no  resume  token  is available. This is possible if the
     change stream has not been iterated and neither resumeAfter nor  startAfter
     options were specified in the watch function.

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

AUTHOR
     MongoDB, Inc

COPYRIGHT
     2009-present, MongoDB, Inc.

1.30.8				  Aug 27, 2026 MONGOC_CHANGE...T_RESUME_TOKEN(3)

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

home | help