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

Interface IotHubTransport

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AmqpsTransport, HttpsTransport, MqttTransport

public interface IotHubTransport
extends Closeable

An interface for an IoT Hub transport.

Method Summary

Modifier and Type	Method and Description
void	addMessage(Message message, IotHubEventCallback callback, Object callbackContext) Adds a message to the transport queue.
void	close() Closes all resources used to communicate with an IoT Hub.
void	handleMessage() Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub.
void	invokeCallbacks() Invokes the callbacks for all completed requests.
boolean	isEmpty() Returns true if the transport has no more messages to handle, and false otherwise.
void	open() Establishes a communication channel with an IoT Hub.
void	sendMessages() Sends all messages on the transport queue.

Method Detail

open

void open()
   throws IOException

Establishes a communication channel with an IoT Hub. If a channel is already open, the function shall do nothing.

Throws:

IOException - if a communication channel cannot be established.

close

void close()
    throws IOException

Closes all resources used to communicate with an IoT Hub. Once close() is called, the transport is no longer usable. If the transport is already closed, the function shall do nothing.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException - if an error occurs in closing the transport.

addMessage

void addMessage(Message message,
                IotHubEventCallback callback,
                Object callbackContext)

Adds a message to the transport queue.

Parameters:

message - the message to be sent.

callback - the callback to be invoked when a response for the message is received.

callbackContext - the context to be passed in when the callback is invoked.

sendMessages

void sendMessages()
           throws IOException

Sends all messages on the transport queue. If a previous send attempt had failed, the function will attempt to resend the messages in the previous attempt.

Throws:

IOException - if the server could not be reached.

invokeCallbacks

void invokeCallbacks()

Invokes the callbacks for all completed requests.

handleMessage

void handleMessage()
            throws IOException

Invokes the message callback if a message is found and responds to the IoT Hub on how the processed message should be handled by the IoT Hub.

If no message callback is set, the function will do nothing.

Throws:

IOException - if the server could not be reached.

isEmpty

boolean isEmpty()

Returns true if the transport has no more messages to handle, and false otherwise.

Returns:

true if the transport has no more messages to handle, and false otherwise.