com.microsoft.azure.sdk.iot.service

Class FeedbackReceiver

java.lang.Object

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

com.microsoft.azure.sdk.iot.service.FeedbackReceiver

public class FeedbackReceiver
extends Receiver

FeedbackReceiver is a specialized receiver whose ReceiveAsync method returns a FeedbackBatch instead of a Message.

Constructor Summary

Constructors

Constructor and Description
FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol) Constructor to verify initialization parameters Create instance of AmqpReceive
FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions) Constructor to verify initialization parameters Create instance of AmqpReceive
FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext) Constructor to verify initialization parameters Create instance of AmqpReceive
FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, String deviceId) Deprecated. As of release 1.1.15, replaced by FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)

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
FeedbackBatch	receive() Receive FeedbackBatch with default timeout This function is synchronized internally so that only one receive operation is allowed at a time.
FeedbackBatch	receive(long timeoutMs) Receive FeedbackBatch with specific timeout This function is synchronized internally so that only one receive operation is allowed at a time.
CompletableFuture<FeedbackBatch>	receiveAsync() Async wrapper for receive() operation with default timeout
CompletableFuture<FeedbackBatch>	receiveAsync(long timeoutMs) Async wrapper for receive() operation with specific timeout

Methods inherited from class java.lang.Object

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

Constructor Detail

FeedbackReceiver

@Deprecated
public FeedbackReceiver(String hostName,
                                     String userName,
                                     String sasToken,
                                     IotHubServiceClientProtocol iotHubServiceClientProtocol,
                                     String deviceId)

Deprecated. As of release 1.1.15, replaced by FeedbackReceiver(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol)

Constructor to verify initialization parameters Create instance of AmqpReceive

Parameters:

hostName - The iot hub host name

userName - The iot hub user name

sasToken - The iot hub SAS token for the given device

iotHubServiceClientProtocol - The iot hub protocol name

deviceId - The device id (not used)

FeedbackReceiver

public FeedbackReceiver(String hostName,
                        String userName,
                        String sasToken,
                        IotHubServiceClientProtocol iotHubServiceClientProtocol)

Constructor to verify initialization parameters Create instance of AmqpReceive

Parameters:

hostName - The iot hub host name

userName - The iot hub user name

sasToken - The iot hub SAS token for the given device

iotHubServiceClientProtocol - protocol to be used

FeedbackReceiver

public FeedbackReceiver(String hostName,
                        String userName,
                        String sasToken,
                        IotHubServiceClientProtocol iotHubServiceClientProtocol,
                        ProxyOptions proxyOptions)

Constructor to verify initialization parameters Create instance of AmqpReceive

Parameters:

hostName - The iot hub host name

userName - The iot hub user name

sasToken - The iot hub SAS token for the given device

iotHubServiceClientProtocol - protocol to be used

proxyOptions - the proxy options to tunnel through, if a proxy should be used.

FeedbackReceiver

public FeedbackReceiver(String hostName,
                        String userName,
                        String sasToken,
                        IotHubServiceClientProtocol iotHubServiceClientProtocol,
                        ProxyOptions proxyOptions,
                        SSLContext sslContext)

Constructor to verify initialization parameters Create instance of AmqpReceive

Parameters:

hostName - The iot hub host name

userName - The iot hub user name

sasToken - The iot hub SAS token for the given device

iotHubServiceClientProtocol - protocol to be used

proxyOptions - the proxy options to tunnel through, if a proxy should be used.

sslContext - the SSL context to use during the TLS handshake when opening the connection. If null, a default SSL context will be generated. This default SSLContext trusts the IoT Hub public certificates.

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 FeedbackBatch receive()
                      throws IOException,
                             InterruptedException

Receive FeedbackBatch with default timeout 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 FeedbackReceiver instance.

Returns:

The received FeedbackBatch 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 FeedbackBatch receive(long timeoutMs)
                      throws IOException,
                             InterruptedException

Receive FeedbackBatch with specific timeout 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 FeedbackReceiver instance.

Parameters:

timeoutMs - The timeout in milliseconds

Returns:

The received FeedbackBatch 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<FeedbackBatch> receiveAsync()

Async wrapper for receive() operation with default timeout

Specified by:

receiveAsync in class Receiver

Returns:

The future object for the requested operation

receiveAsync

public CompletableFuture<FeedbackBatch> receiveAsync(long timeoutMs)

Async wrapper for receive() operation with specific timeout

Specified by:

receiveAsync in class Receiver

Returns:

The future object for the requested operation