1MONGOC_CURSOR_SET_MAX_AWAIT_TIME_MS(l3i)bmonMgOoNcGOC_CURSOR_SET_MAX_AWAIT_TIME_MS(3)
2
3
4

NAME

6       mongoc_cursor_set_max_await_time_ms            -            mongoc_cur‐
7       sor_set_max_await_time_ms()
8

SYNOPSIS

10          void
11          mongoc_cursor_set_max_await_time_ms (mongoc_cursor_t *cursor,
12                                               uint32_t max_await_time_ms);
13

PARAMETERS

15       • cursor: A mongoc_cursor_t.
16
17       • max_await_time_ms: A timeout in milliseconds.
18

DESCRIPTION

20       The maximum amount of time for the server to wait on new  documents  to
21       satisfy  a tailable cursor query. Only applies if the cursor is created
22       from mongoc_collection_find_with_opts() with "tailable" and "awaitData"
23       options,  and the server is MongoDB 3.2 or later. See the documentation
24       for maxTimeMS and the "getMore" command.
25
26       The max_await_time_ms  cannot  be  changed  after  the  first  call  to
27       mongoc_cursor_next().
28
29       This     is     not     applicable     to    all    cursors.    Calling
30       mongoc_cursor_set_batch_size()    on    a    cursor     returned     by
31       mongoc_client_find_databases_with_opts(),
32       mongoc_database_find_collections_with_opts(),                        or
33       mongoc_collection_find_indexes_with_opts() will not change the results.
34
35       Note:  although  max_await_time_ms is a uint32_t, it is possible to set
36       it as a uint64_t through the options arguments in some cursor returning
37       functions like mongoc_collection_find_with_opts().
38
39       SEE ALSO:
40          Tailable Cursors.
41
42

AUTHOR

44       MongoDB, Inc
45

47       2017-present, MongoDB, Inc
48
49
50
51
521.24.3                           Aug 17,M2O0N2G3OC_CURSOR_SET_MAX_AWAIT_TIME_MS(3)
Impressum