mongoc_cursor_set_max_await_time_ms man page

mongoc_cursor_set_max_await_time_ms() — The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Only applies if the cursor is created from mongoc_collection_find_with_opts with "tailable" and "awaitData" options, and the server is MongoDB 3.2 or later. See the documentation for maxTimeMS and the "getMore" command.

Synopsis

void
mongoc_cursor_set_max_await_time_ms (mongoc_cursor_t *cursor,
                                     uint32_t         max_await_time_ms);

Parameters

cursor
A mongoc_cursor_t
max_await_time_ms
A timeout in milliseconds.

Description

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. Only applies if the cursor is created from mongoc_collection_find_with_opts with "tailable" and "awaitData" options, and the server is MongoDB 3.2 or later. See the documentation for maxTimeMS and the getMore command

The max_await_time_ms cannot be changed after the first call to mongoc_cursor_next

See Also

Tailable Cursors.

Colophon

This page is part of MongoDB C Driver. Please report any bugs at https://jira.mongodb.org/browse/CDRIVER.

Info

2016‐11‐08 MongoDB C Driver