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

Class HttpsIotHubConnection

java.lang.Object

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

public class HttpsIotHubConnection
extends Object

An HTTPS connection between a device and an IoT Hub. Contains functionality for synchronously connecting to the different IoT Hub resource URIs.

Field Summary

Fields

Modifier and Type	Field and Description
protected DeviceClientConfig	config The client configuration.
protected static Object	HTTPS_CONNECTION_LOCK The HTTPS connection lock.
protected String	messageEtag The message e-tag.

Constructor Summary

Constructors

Constructor and Description
HttpsIotHubConnection(DeviceClientConfig config) Constructs an instance from the given DeviceClientConfig object.

Method Summary

Modifier and Type	Method and Description
Message	receiveMessage() Receives a message, if one exists.
protected static String	sanitizeEtag(String dirtyEtag) Removes double quotes from the e-tag property.
IotHubStatusCode	sendEvent(HttpsMessage msg) Sends an event message.
void	sendMessageResult(IotHubMessageResult result) Sends the message result for the previously received message.

Methods inherited from class java.lang.Object

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

Field Detail

HTTPS_CONNECTION_LOCK

protected static final Object HTTPS_CONNECTION_LOCK

The HTTPS connection lock.

config

protected final DeviceClientConfig config

The client configuration.

messageEtag

protected String messageEtag

The message e-tag. Obtained when the device receives a message and used when sending a message result back to the IoT Hub.

Constructor Detail

HttpsIotHubConnection

public HttpsIotHubConnection(DeviceClientConfig config)

Constructs an instance from the given DeviceClientConfig object.

Parameters:

config - the client configuration.

Method Detail

sendEvent

public IotHubStatusCode sendEvent(HttpsMessage msg)
                           throws IOException

Sends an event message.

Parameters:

msg - the event message.

Returns:

the status code from sending the event message.

Throws:

IOException - if the IoT Hub could not be reached.

receiveMessage

public Message receiveMessage()
                       throws IOException

Receives a message, if one exists.

Returns:

a message, or null if none exists.

Throws:

IOException - if the IoT Hub could not be reached.

sendMessageResult

public void sendMessageResult(IotHubMessageResult result)
                       throws IOException

Sends the message result for the previously received message.

Parameters:

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

Throws:

IllegalStateException - if sendMessageResult is called before receiveMessage() is called.

IOException - if the IoT Hub could not be reached.

sanitizeEtag

protected static String sanitizeEtag(String dirtyEtag)

Removes double quotes from the e-tag property.

Parameters:

dirtyEtag - the dirty e-tag value.

Returns:

the e-tag value with double quotes removed.