Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions driver-core/src/main/com/mongodb/ClientEncryptionSettings.java
Original file line number Diff line number Diff line change
Expand Up @@ -172,10 +172,15 @@ public Builder keyExpiration(@Nullable final Long keyExpiration, final TimeUnit
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>Note:</strong> The timeout set through this method overrides the timeout defined in the key vault client settings
* specified in {@link #keyVaultMongoClientSettings(MongoClientSettings)}.
* Essentially, for operations that require accessing the key vault, the remaining timeout from the initial operation
* determines the duration allowed for key vault access.</p>
* <p><strong>NOTE:</strong></p>
* <ul>
* <li>The timeout set through this method overrides the timeout defined in the key vault client settings
* specified in {@link #keyVaultMongoClientSettings(MongoClientSettings)}.
* Essentially, for operations that require accessing the key vault, the remaining timeout from the initial operation
* determines the duration allowed for key vault access.</li>
* <li>When using synchronous API, this timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected. This limitation does not apply to the reactive streams API.</li>
* </ul>
*
* @param timeout the timeout
* @param timeUnit the time unit
Expand Down
5 changes: 5 additions & 0 deletions driver-core/src/main/com/mongodb/ClientSessionOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -220,6 +220,11 @@ public Builder defaultTransactionOptions(final TransactionOptions defaultTransac
* <li>{@code withTransaction}</li>
* <li>{@code close}</li>
* </ul>
*
* <p><strong>NOTE:</strong> When using synchronous API, this timeout does not limit socket writes, therefore
* there is a possibility that the operation might not be timed out when expected. This limitation does not
* apply to the reactive streams API.
*
* @param defaultTimeout the timeout
* @param timeUnit the time unit
* @return this
Expand Down
3 changes: 3 additions & 0 deletions driver-core/src/main/com/mongodb/MongoClientSettings.java
Original file line number Diff line number Diff line change
Expand Up @@ -699,6 +699,9 @@ public Builder inetAddressResolver(@Nullable final InetAddressResolver inetAddre
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> When using synchronous API, this timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected. This limitation does not apply to the reactive streams API.
*
* @param timeout the timeout
* @param timeUnit the time unit
* @return this
Expand Down
3 changes: 3 additions & 0 deletions driver-core/src/main/com/mongodb/TransactionOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -292,6 +292,9 @@ public Builder maxCommitTime(@Nullable final Long maxCommitTime, final TimeUnit
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> When using synchronous API, this timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected. This limitation does not apply to the reactive streams API.
*
* @param timeout the timeout
* @param timeUnit the time unit
* @return this
Expand Down
2 changes: 1 addition & 1 deletion driver-core/src/test/resources/specifications
Submodule specifications updated 111 files
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
* - `0` means infinite timeout.
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @return the optional timeout duration
*/
@Alpha(Reason.CLIENT)
Expand Down Expand Up @@ -131,6 +134,9 @@ public open class MongoCluster protected constructor(private val wrapped: JMongo
* - `0` means an infinite timeout
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit, defaults to Milliseconds
* @return a new MongoCluster instance with the set time limit for operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,9 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
* - `0` means infinite timeout.
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @return the optional timeout duration
* @since 5.2
*/
Expand Down Expand Up @@ -176,6 +179,9 @@ public class MongoCollection<T : Any>(private val wrapped: JMongoCollection<T>)
* - `0` means an infinite timeout
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit, defaults to Milliseconds
* @return a new MongoCollection instance with the set time limit for operations
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
* - `0` means infinite timeout.
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @return the optional timeout duration
* @since 5.2
*/
Expand Down Expand Up @@ -125,6 +128,9 @@ public class MongoDatabase(private val wrapped: JMongoDatabase) {
* - `0` means an infinite timeout
* - `> 0` The time limit to use for the full execution of an operation.
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit, defaults to Milliseconds
* @return a new MongoDatabase instance with the set time limit for operations
Expand Down
3 changes: 3 additions & 0 deletions driver-legacy/src/main/com/mongodb/MongoClientOptions.java
Original file line number Diff line number Diff line change
Expand Up @@ -1370,6 +1370,9 @@ public Builder srvServiceName(final String srvServiceName) {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>Note:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeoutMS the timeout in milliseconds
* @return this
* @since 5.2
Expand Down
3 changes: 3 additions & 0 deletions driver-sync/src/main/com/mongodb/client/MongoCluster.java
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,9 @@ public interface MongoCluster {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit
* @return a new MongoCluster instance with the set time limit for the full execution of an operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,9 @@ public interface MongoCollection<TDocument> {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit
* @return a new MongoCollection instance with the set time limit for the full execution of an operation
Expand Down
3 changes: 3 additions & 0 deletions driver-sync/src/main/com/mongodb/client/MongoDatabase.java
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,9 @@ public interface MongoDatabase {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit
* @return a new MongoDatabase instance with the set time limit for the full execution of an operation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,9 @@ public interface GridFSBucket {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeUnit the time unit
* @return the timeout in the given time unit
* @since 4.x
Expand Down Expand Up @@ -155,6 +158,9 @@ public interface GridFSBucket {
* <li>{@code > 0} The time limit to use for the full execution of an operation.</li>
* </ul>
*
* <p><strong>NOTE:</strong> This timeout does not limit socket writes, therefore there is a possibility that the
* operation might not be timed out when expected.
*
* @param timeout the timeout, which must be greater than or equal to 0
* @param timeUnit the time unit
* @return a new GridFSBucket instance with the set time limit for the full execution of an operation
Expand Down