com.microsoft.azure.sdk.iot.service.transport.amqps

Class AmqpReceive

java.lang.Object

com.microsoft.azure.sdk.iot.service.transport.amqps.AmqpReceive

All Implemented Interfaces:

AmqpFeedbackReceivedEvent

public class AmqpReceive
extends Object
implements AmqpFeedbackReceivedEvent

Instance of the QPID-Proton-J BaseHandler class overriding the events what are needed to handle high level open, close methods and feedback received event.

Constructor Summary

Constructors

Constructor and Description
AmqpReceive(String hostName, com.azure.core.credential.AzureSasCredential sasTokenProvider, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)
AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol) Constructor to set up connection parameters
AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions) Constructor to set up connection parameters
AmqpReceive(String hostName, String userName, String sasToken, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext) Constructor to set up connection parameters
AmqpReceive(String hostName, com.azure.core.credential.TokenCredential credential, IotHubServiceClientProtocol iotHubServiceClientProtocol, ProxyOptions proxyOptions, SSLContext sslContext)

Method Summary

Modifier and Type	Method and Description
void	close() Invalidate AmqpsReceiveHandler member variable
void	onFeedbackReceived(String feedbackJson) Handle on feedback received Proton event Parse received json and save result to a member variable Release semaphore for wait function
void	open() Create AmqpsReceiveHandler and store it in a member variable
FeedbackBatch	receive(long timeoutMs) Synchronized call to receive feedback batch Hide the event based receiving mechanism from the user API

Methods inherited from class java.lang.Object

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

Constructor Detail

AmqpReceive

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

Constructor to set up connection parameters

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

AmqpReceive

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

Constructor to set up connection parameters

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

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

AmqpReceive

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

Constructor to set up connection parameters

Parameters:

hostName - The address string of the service (example: AAA.BBB.CCC)

userName - The username string to use SASL authentication (example: user@sas.service)

sasToken - The SAS token string

iotHubServiceClientProtocol - protocol to use

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.

AmqpReceive

public AmqpReceive(String hostName,
                   com.azure.core.credential.TokenCredential credential,
                   IotHubServiceClientProtocol iotHubServiceClientProtocol,
                   ProxyOptions proxyOptions,
                   SSLContext sslContext)

AmqpReceive

public AmqpReceive(String hostName,
                   com.azure.core.credential.AzureSasCredential sasTokenProvider,
                   IotHubServiceClientProtocol iotHubServiceClientProtocol,
                   ProxyOptions proxyOptions,
                   SSLContext sslContext)

Method Detail

open

public void open()

Create AmqpsReceiveHandler and store it in a member variable

close

public void close()

Invalidate AmqpsReceiveHandler member variable

receive

public FeedbackBatch receive(long timeoutMs)
                      throws IOException,
                             InterruptedException

Synchronized call to receive feedback batch Hide the event based receiving mechanism from the user API

Parameters:

timeoutMs - The timeout in milliseconds to wait for the feedback

Returns:

The received feedback batch

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

onFeedbackReceived

public void onFeedbackReceived(String feedbackJson)

Handle on feedback received Proton event Parse received json and save result to a member variable Release semaphore for wait function

Specified by:

onFeedbackReceived in interface AmqpFeedbackReceivedEvent

Parameters:

feedbackJson - Received Json string to process