FileUploadNotificationReceiver Class

  • Reference
Package:
com.microsoft.azure.sdk.iot.service
Maven Artifact:
com.microsoft.azure.sdk.iot:iot-service-client:1.30.0

public class FileUploadNotificationReceiver
extends Receiver

Method Summary

Modifier and Type Method and Description
void close()

Close AmqpReceive object
java.util.concurrent.CompletableFuture<java.lang.Void> closeAsync()

Async wrapper for close() operation
void open()

Open AmqpReceive object
java.util.concurrent.CompletableFuture<java.lang.Void> openAsync()

Async wrapper for open() operation
FileUploadNotification receive()

Receive FileUploadNotification with default timeout QoS for receiving file upload notifications is at least once This function is synchronized internally so that only one receive operation is allowed at a time.
FileUploadNotification receive(long timeoutMs)

Receive FileUploadNotification with specific timeout QoS for receiving file upload notifications is at least once This function is synchronized internally so that only one receive operation is allowed at a time.
java.util.concurrent.CompletableFuture<FileUploadNotification> receiveAsync()

Async wrapper for receive() operation with default timeout QoS for receiving file upload notifications is at least once
java.util.concurrent.CompletableFuture<FileUploadNotification> receiveAsync(long timeoutMs)

Async wrapper for receive() operation with specific timeout QoS for receiving file upload notifications is at least once

Methods inherited from Receiver

closeAsync openAsync receiveAsync receiveAsync

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Method Details

close

public void close()

Close AmqpReceive object

Throws:

java.io.IOException - This exception is thrown if the input AmqpReceive object is null

closeAsync

public CompletableFuture closeAsync()

Async wrapper for close() operation

Overrides:

FileUploadNotificationReceiver.closeAsync()

Returns:

The future object for the requested operation

open

public void open()

Open AmqpReceive object

Throws:

java.io.IOException - This exception is thrown if the input AmqpReceive object is null

openAsync

public CompletableFuture openAsync()

Async wrapper for open() operation

Overrides:

FileUploadNotificationReceiver.openAsync()

Returns:

The future object for the requested operation

receive

public FileUploadNotification receive()

Receive FileUploadNotification with default timeout QoS for receiving file upload notifications is at least once This function is synchronized internally so that only one receive operation is allowed at a time. In order to do more receive operations at a time, you will need to instantiate another FileUploadNotificationReceiver instance.

Returns:

The received FileUploadNotification object

Throws:

java.io.IOException - This exception is thrown if the input AmqpReceive object is null
java.lang.InterruptedException - This exception is thrown if the input AmqpReceive object is null

receive

public FileUploadNotification receive(long timeoutMs)

Receive FileUploadNotification with specific timeout QoS for receiving file upload notifications is at least once This function is synchronized internally so that only one receive operation is allowed at a time. In order to do more receive operations at a time, you will need to instantiate another FileUploadNotificationReceiver instance.

Parameters:

timeoutMs - The timeout in milliseconds

Returns:

The received FileUploadNotification object

Throws:

java.io.IOException - This exception is thrown if the input AmqpReceive object is null
java.lang.InterruptedException - This exception is thrown if the input AmqpReceive object is null

receiveAsync

public CompletableFuture receiveAsync()

Async wrapper for receive() operation with default timeout QoS for receiving file upload notifications is at least once

Overrides:

FileUploadNotificationReceiver.receiveAsync()

Returns:

The future object for the requested operation

receiveAsync

public CompletableFuture receiveAsync(long timeoutMs)

Async wrapper for receive() operation with specific timeout QoS for receiving file upload notifications is at least once

Overrides:

FileUploadNotificationReceiver.receiveAsync(long timeoutMs)

Parameters:

timeoutMs

Returns:

The future object for the requested operation

Applies to