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

Class AmqpsIotHubConnection

java.lang.Object

org.apache.qpid.proton.engine.BaseHandler

com.microsoft.azure.sdk.iot.device.transport.amqps.AmqpsIotHubConnection

All Implemented Interfaces:

org.apache.qpid.proton.engine.CoreHandler, org.apache.qpid.proton.engine.Handler

public final class AmqpsIotHubConnection
extends org.apache.qpid.proton.engine.BaseHandler

An AMQPS IotHub connection between a device and an IoTHub. This class contains functionality for sending/receiving a message, and logic to re-establish the connection with the IoTHub in case it gets lost.

Field Summary

Fields

Modifier and Type	Field and Description
protected DeviceClientConfig	config
protected State	state

Constructor Summary

Constructors

Constructor and Description
AmqpsIotHubConnection(DeviceClientConfig config, Boolean useWebSockets) Constructor to set up connection parameters using the DeviceClientConfig.

Method Summary

Modifier and Type	Method and Description
void	addListener(ServerListener listener) Subscribe a listener to the list of listeners.
void	close() Closes the AmqpsIotHubConnection.
void	onConnectionBound(org.apache.qpid.proton.engine.Event event) Event handler for the connection bound event.
void	onConnectionInit(org.apache.qpid.proton.engine.Event event) Event handler for the connection init event
void	onConnectionUnbound(org.apache.qpid.proton.engine.Event event)
void	onDelivery(org.apache.qpid.proton.engine.Event event) Event handler for the delivery event.
void	onLinkFlow(org.apache.qpid.proton.engine.Event event) Event handler for the link flow event.
void	onLinkInit(org.apache.qpid.proton.engine.Event event) Event handler for the link init event.
void	onLinkRemoteClose(org.apache.qpid.proton.engine.Event event) Event handler for the link remote close event.
void	onLinkRemoteOpen(org.apache.qpid.proton.engine.Event event) Event handler for the link remote open event.
void	onReactorFinal(org.apache.qpid.proton.engine.Event event)
void	onReactorInit(org.apache.qpid.proton.engine.Event event) Event handler for reactor init event.
void	onTransportError(org.apache.qpid.proton.engine.Event event) Event handler for the transport error event.
void	open() Opens the AmqpsIotHubConnection.
Integer	sendMessage(org.apache.qpid.proton.message.Message message) Creates a binary message using the given content and messageId.
Boolean	sendMessageResult(AmqpsMessage message, IotHubMessageResult result) Sends the message result for the previously received message.

Methods inherited from class org.apache.qpid.proton.engine.BaseHandler

add, children, getHandler, getHandler, handle, onConnectionFinal, onConnectionLocalClose, onConnectionLocalOpen, onConnectionRemoteClose, onConnectionRemoteOpen, onLinkFinal, onLinkLocalClose, onLinkLocalDetach, onLinkLocalOpen, onLinkRemoteDetach, onReactorQuiesced, onSelectableError, onSelectableExpired, onSelectableFinal, onSelectableInit, onSelectableReadable, onSelectableUpdated, onSelectableWritable, onSessionFinal, onSessionInit, onSessionLocalClose, onSessionLocalOpen, onSessionRemoteClose, onSessionRemoteOpen, onTimerTask, onTransport, onTransportClosed, onTransportHeadClosed, onTransportTailClosed, onUnhandled, setHandler, setHandler

Methods inherited from class java.lang.Object

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

Field Detail

state

protected State state

config

protected DeviceClientConfig config

Constructor Detail

AmqpsIotHubConnection

public AmqpsIotHubConnection(DeviceClientConfig config,
                             Boolean useWebSockets)
                      throws IOException

Constructor to set up connection parameters using the DeviceClientConfig.

Parameters:

config - The DeviceClientConfig corresponding to the device associated with this DeviceClient.

useWebSockets - Whether the connection should use web sockets or not.

Throws:

IOException

Method Detail

open

public void open()
          throws IOException

Opens the AmqpsIotHubConnection.

If the current connection is not open, this method will create a new IotHubSasToken. This method will start the Reactor, set the connection to open and make it ready for sending.

Throws:

IOException - If the reactor could not be initialized.

close

public void close()
           throws IOException

Closes the AmqpsIotHubConnection.

If the current connection is not closed, this function will set the current state to closed and invalidate all connection related variables.

Throws:

IOException

sendMessage

public Integer sendMessage(org.apache.qpid.proton.message.Message message)

Creates a binary message using the given content and messageId. Sends the created message using the sender link.

Parameters:

message - The message to be sent.

Returns:

An Integer representing the hash of the message, or -1 if the connection is closed.

sendMessageResult

public Boolean sendMessageResult(AmqpsMessage message,
                                 IotHubMessageResult result)

Sends the message result for the previously received message.

Parameters:

message - the message to be acknowledged.

result - the message result (one of IotHubMessageResult.COMPLETE, IotHubMessageResult.ABANDON, or IotHubMessageResult.REJECT).

onConnectionInit

public void onConnectionInit(org.apache.qpid.proton.engine.Event event)

Event handler for the connection init event

Specified by:

onConnectionInit in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionInit in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onConnectionBound

public void onConnectionBound(org.apache.qpid.proton.engine.Event event)

Event handler for the connection bound event. Sets Sasl authentication and proper authentication mode.

Specified by:

onConnectionBound in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionBound in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onConnectionUnbound

public void onConnectionUnbound(org.apache.qpid.proton.engine.Event event)

Specified by:

onConnectionUnbound in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onConnectionUnbound in class org.apache.qpid.proton.engine.BaseHandler

onReactorInit

public void onReactorInit(org.apache.qpid.proton.engine.Event event)

Event handler for reactor init event.

Specified by:

onReactorInit in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onReactorInit in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - Proton Event object

onReactorFinal

public void onReactorFinal(org.apache.qpid.proton.engine.Event event)

Specified by:

onReactorFinal in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onReactorFinal in class org.apache.qpid.proton.engine.BaseHandler

onDelivery

public void onDelivery(org.apache.qpid.proton.engine.Event event)

Event handler for the delivery event. This method handles both sending and receiving a message.

Specified by:

onDelivery in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onDelivery in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onLinkFlow

public void onLinkFlow(org.apache.qpid.proton.engine.Event event)

Event handler for the link flow event. Handles sending a single message.

Specified by:

onLinkFlow in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onLinkFlow in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onLinkRemoteOpen

public void onLinkRemoteOpen(org.apache.qpid.proton.engine.Event event)

Event handler for the link remote open event. This signifies that the Reactor is ready, so we set the connection to OPEN.

Specified by:

onLinkRemoteOpen in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onLinkRemoteOpen in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onLinkRemoteClose

public void onLinkRemoteClose(org.apache.qpid.proton.engine.Event event)

Event handler for the link remote close event. This triggers reconnection attempts until successful. Both sender and receiver links closing trigger this event, so we only handle one of them, since the other is redundant.

Specified by:

onLinkRemoteClose in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onLinkRemoteClose in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onLinkInit

public void onLinkInit(org.apache.qpid.proton.engine.Event event)

Event handler for the link init event. Sets the proper target address on the link.

Specified by:

onLinkInit in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onLinkInit in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

onTransportError

public void onTransportError(org.apache.qpid.proton.engine.Event event)

Event handler for the transport error event. This triggers reconnection attempts until successful.

Specified by:

onTransportError in interface org.apache.qpid.proton.engine.CoreHandler

Overrides:

onTransportError in class org.apache.qpid.proton.engine.BaseHandler

Parameters:

event - The Proton Event object.

addListener

public void addListener(ServerListener listener)

Subscribe a listener to the list of listeners.

Parameters:

listener - the listener to be subscribed.