Add Javadoc to specify that CSOT does not limit socket writes #1791
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Member
There was a problem hiding this comment. We should revert the changes to |
Submodule specifications
updated
71 files
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
Member
There was a problem hiding this comment. To be consistent with the majority of API notes in the The same suggestion applies to the rest of the |
||
| * operation might not be timed out when expected. | ||
|
Member
There was a problem hiding this comment. We should also add this note to the The same suggestion applies to the rest of the |
||
| * | ||
| * @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. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | ||
|
Member
There was a problem hiding this comment. To be consistent with the majority of API notes in the com.mongodb package, we should say The same suggestion applies to 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 | ||
|
|
@@ -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 | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To be consistent with the majority of API notes in the
com.mongodbpackage, we should say<p>Note: When....The same suggestion applies to the rest of the
driver-core/src/main/com/mongodbfiles modified in the PR.