1MONGOC_CURSOR_SET_MAX_AWAIT_TIME_MS(l3i)bmonMgOoNcGOC_CURSOR_SET_MAX_AWAIT_TIME_MS(3)
2
3
4
6 void
7 mongoc_cursor_set_max_await_time_ms (mongoc_cursor_t *cursor,
8 uint32_t max_await_time_ms);
9
11 • cursor: A mongoc_cursor_t.
12
13 • max_await_time_ms: A timeout in milliseconds.
14
16 The maximum amount of time for the server to wait on new documents to
17 satisfy a tailable cursor query. Only applies if the cursor is created
18 from mongoc_collection_find_with_opts() with "tailable" and "awaitData"
19 options, and the server is MongoDB 3.2 or later. See the documentation
20 for maxTimeMS and the "getMore" command.
21
22 The max_await_time_ms cannot be changed after the first call to
23 mongoc_cursor_next().
24
25 This is not applicable to all cursors. Calling
26 mongoc_cursor_set_batch_size() on a cursor returned by
27 mongoc_client_find_databases_with_opts(),
28 mongoc_database_find_collections_with_opts(), or
29 mongoc_collection_find_indexes_with_opts() will not change the results.
30
31 Note: although max_await_time_ms is a uint32_t, it is possible to set
32 it as a uint64_t through the options arguments in some cursor returning
33 functions like mongoc_collection_find_with_opts().
34
35 SEE ALSO:
36 Tailable Cursors.
37
38
40 MongoDB, Inc
41
43 2017-present, MongoDB, Inc
44
45
46
47
481.25.1 Nov 08,M2O0N2G3OC_CURSOR_SET_MAX_AWAIT_TIME_MS(3)