com.microsoft.azure.sdk.iot.service

Class FileUploadNotificationReceiver

java.lang.Object

com.microsoft.azure.sdk.iot.service.Receiver

com.microsoft.azure.sdk.iot.service.FileUploadNotificationReceiver

public class FileUploadNotificationReceiver
extends Receiver

Method Summary

Modifier and Type	Method and Description
void	close() Close AmqpReceive object
CompletableFuture<Void>	closeAsync() Async wrapper for close() operation
void	open() Open AmqpReceive object
CompletableFuture<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.
CompletableFuture<FileUploadNotification>	receiveAsync() Async wrapper for receive() operation with default timeout QoS for receiving file upload notifications is at least once
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

open

public void open()
          throws IOException

Open AmqpReceive object

Throws:

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

close

public void close()
           throws IOException

Close AmqpReceive object

Throws:

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

receive

public FileUploadNotification receive()
                               throws IOException,
                                      InterruptedException

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:

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

InterruptedException - This exception is thrown if the receive process has been interrupted

receive

public FileUploadNotification receive(long timeoutMs)
                               throws IOException,
                                      InterruptedException

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:

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

InterruptedException - This exception is thrown if the receive process has been interrupted

openAsync

public CompletableFuture<Void> openAsync()

Async wrapper for open() operation

Specified by:

openAsync in class Receiver

Returns:

The future object for the requested operation

closeAsync

public CompletableFuture<Void> closeAsync()

Async wrapper for close() operation

Specified by:

closeAsync in class Receiver

Returns:

The future object for the requested operation

receiveAsync

public CompletableFuture<FileUploadNotification> receiveAsync()

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

Specified by:

receiveAsync in class Receiver

Returns:

The future object for the requested operation

receiveAsync

public CompletableFuture<FileUploadNotification> receiveAsync(long timeoutMs)

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

Specified by:

receiveAsync in class Receiver

Returns:

The future object for the requested operation