Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(iot-serv): Add documentation to fileuploadNotificationReceiver about QoS #619

Merged
merged 2 commits into from
Nov 7, 2019
Merged

doc(iot-serv): Add documentation to fileuploadNotificationReceiver about QoS #619

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce3815e
doc(iot-serv): Add documentation to fileuploadNotificationReceiver ab…
timtay-microsoft Nov 5, 2019
aeb8dd3
Merge branch 'master' into fileuploadNotification
timtay-microsoft Nov 6, 2019
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
9 changes: 9 additions & 0 deletions ...ent/src/main/java/com/microsoft/azure/sdk/iot/service/FileUploadNotificationReceiver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ public void close() throws IOException
/**
* Receive FileUploadNotification with default timeout
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to document default timeout as well.

*
* QoS for receiving file upload notifications is at least once
*
* @return The received FileUploadNotification object
* @throws IOException This exception is thrown if the input AmqpReceive object is null
* @throws InterruptedException This exception is thrown if the receive process has been interrupted
Expand All @@ -87,6 +89,9 @@ public FileUploadNotification receive() throws IOException, InterruptedException

/**
* Receive FileUploadNotification with specific timeout
*
* QoS for receiving file upload notifications is at least once
*
* @param timeoutMs The timeout in milliseconds
* @return The received FileUploadNotification object
* @throws IOException This exception is thrown if the input AmqpReceive object is null
Expand Down Expand Up @@ -152,6 +157,8 @@ public CompletableFuture<Void> closeAsync()
/**
* Async wrapper for receive() operation with default timeout
*
* QoS for receiving file upload notifications is at least once
*
* @return The future object for the requested operation
*/
@Override
Expand All @@ -164,6 +171,8 @@ public CompletableFuture<FileUploadNotification> receiveAsync()
/**
* Async wrapper for receive() operation with specific timeout
*
* QoS for receiving file upload notifications is at least once
*
* @return The future object for the requested operation
*/
@Override
Expand Down