mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/MongoCluster/timeout

timeout

@Alpha(value = [Reason.CLIENT])
fun timeout(timeUnit: TimeUnit = TimeUnit.MILLISECONDS): Long?

The time limit for the full execution of an operation.

If not null the following deprecated options will be ignored: waitQueueTimeoutMS, socketTimeoutMS, wTimeoutMS, maxTimeMS and maxCommitTimeMS.

  • null means that the timeout mechanism for operations will defer to using:

    • waitQueueTimeoutMS: The maximum wait time in milliseconds that a thread may wait for a connection to become available

    • socketTimeoutMS: How long a send or receive on a socket can take before timing out.

    • wTimeoutMS: How long the server will wait for the write concern to be fulfilled before timing out.

    • maxTimeMS: The time limit for processing operations on a cursor. See: cursor.maxTimeMS.

    • maxCommitTimeMS: The maximum amount of time to allow a single commitTransaction command to execute.

  • 0 means infinite timeout.

  • > 0 The time limit to use for the full execution of an operation.

Return

the optional timeout duration