.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MONGOC_CURSOR_SET_MAX_AWAIT_TIME_MS" "3" "May 07, 2024" "1.27.1" "libmongoc"
.SH SYNOPSIS
.INDENT 0.0
.INDENT 3.5
.sp
.EX
void
mongoc_cursor_set_max_await_time_ms (mongoc_cursor_t *cursor,
                                     uint32_t max_await_time_ms);
.EE
.UNINDENT
.UNINDENT
.SH PARAMETERS
.INDENT 0.0
.IP \(bu 2
\fBcursor\fP: A \fI\%mongoc_cursor_t\fP\&.
.IP \(bu 2
\fBmax_await_time_ms\fP: A timeout in milliseconds.
.UNINDENT
.SH DESCRIPTION
.sp
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 \fI\%mongoc_collection_find_with_opts()\fP with \(dqtailable\(dq and \(dqawaitData\(dq options, and the server is MongoDB 3.2 or later. See \fI\%the documentation for maxTimeMS and the \(dqgetMore\(dq command\fP\&.
.sp
The \fBmax_await_time_ms\fP cannot be changed after the first call to \fI\%mongoc_cursor_next()\fP\&.
.sp
This is not applicable to all cursors. Calling \fI\%mongoc_cursor_set_batch_size()\fP on a cursor returned by \fI\%mongoc_client_find_databases_with_opts()\fP, \fI\%mongoc_database_find_collections_with_opts()\fP, or \fI\%mongoc_collection_find_indexes_with_opts()\fP will not change the results.
.sp
Note: although \fBmax_await_time_ms\fP is a uint32_t, it is possible to set it as a uint64_t through the options arguments in some cursor returning functions like \fI\%mongoc_collection_find_with_opts()\fP\&.
.sp
\fBSEE ALSO:\fP
.INDENT 0.0
.INDENT 3.5
.nf
\fI\%Tailable Cursors.\fP
.fi
.sp
.UNINDENT
.UNINDENT
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.