kmongo / org.litote.kmongo.coroutine / CoroutineFindPublisher / maxAwaitTime

maxAwaitTime

fun maxAwaitTime(maxAwaitTime: Long, timeUnit: TimeUnit): CoroutineFindPublisher<T> (source)

The maximum amount of time for the server to wait on new documents to satisfy a tailable cursor query. This only applies to a TAILABLE_AWAIT cursor. When the cursor is not a TAILABLE_AWAIT cursor, this option is ignored.

On servers &gt;= 3.2, this option will be specified on the getMore command as "maxTimeMS". The default is no value: no "maxTimeMS" is sent to the server with the getMore command.

On servers < 3.2, this option is ignored, and indicates that the driver should respect the server's default value

A zero value will be ignored.

Parameters

maxAwaitTime - the max await time

timeUnit - the time unit to return the result in

Return
the maximum await execution time in the given time unit

Mongodb
.driver.manual reference/method/cursor.maxTimeMS/#cursor.maxTimeMS Max Time

Since
1.2