Add Javadoc to specify that CSOT does not limit socket writes #1791
Conversation
…hronous API. JAVA-5569
vbabanin
changed the title
# Conflicts: # driver-core/src/test/resources/specifications
JAVA-5569
| * <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 |
There was a problem hiding this comment.
To be consistent with the rest of the API notes in this class, then we should say
| * <p><strong>Note:</strong> This timeout does not limit socket writes, therefore there is a possibility that the | |
| * <p>Note that this timeout does not limit socket writes, therefore there is a possibility that the |
| * <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 |
There was a problem hiding this comment.
To be consistent with the majority of API notes in the com.mongodb package, we should say <p>Note: When....
The same suggestion applies to the rest of the driver-core/src/main/com/mongodb files modified in the PR.
| * </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. |
There was a problem hiding this comment.
We should also add this note to the MongoClientOptions.getTimeout method.
| * </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. |
There was a problem hiding this comment.
We should also add this note to the MongoClientSettings.getTimeout method.
The same suggestion applies to the rest of the driver-core/src/main/com/mongodb files modified in the PR.
| * <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 |
There was a problem hiding this comment.
To be consistent with the majority of API notes in the com.mongodb package, we should say <p>Note: This....
The same suggestion applies to the GridFSBucket.withTimeout method.
| * - `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 |
There was a problem hiding this comment.
To be consistent with the majority of API notes in the com.mongodb.kotlin.client package, we should say Note: This.... (Kotlin does not seen to require HTML in documentation comments).
The same suggestion applies to the MongoCluster.withTimeout method and to rest of the driver-kotlin-sync/src/main/kotlin/com/mongodb/kotlin/client files modified in the PR.
| * <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 |
There was a problem hiding this comment.
To be consistent with the majority of API notes in the com.mongodb.client package, we should say <p>Note: This....
The same suggestion applies to the rest of the driver-sync/src/main/com/mongodb/client files modified in the PR.
| * </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. |
There was a problem hiding this comment.
We should also add this note to the MongoCluster.getTimeout method.
The same suggestion applies to the rest of the driver-sync/src/main/com/mongodb/client files modified in the PR.
There was a problem hiding this comment.
We should revert the changes to driver-core/src/test/resources/specifications
2 participants
JAVA-5569