com.microsoft.azure.sdk.iot.device

Enum IotHubConnectionStatusChangeReason

java.lang.Object

java.lang.Enum<IotHubConnectionStatusChangeReason>

com.microsoft.azure.sdk.iot.device.IotHubConnectionStatusChangeReason

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<IotHubConnectionStatusChangeReason>

public enum IotHubConnectionStatusChangeReason
extends java.lang.Enum<IotHubConnectionStatusChangeReason>

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_CREDENTIAL Incorrect credentials were supplied to the client instance.
CLIENT_CLOSE The client has been closed gracefully.
COMMUNICATION_ERROR This can be returned with either a connection status of IotHubConnectionStatus.DISCONNECTED or IotHubConnectionStatus.DISCONNECTED_RETRYING.
CONNECTION_OK The client is connected, and ready to be used.
EXPIRED_SAS_TOKEN The SAS token associated with the client has expired, and cannot be renewed.
NO_NETWORK The client was disconnected due to loss of network, the client will attempt for recovery.
RETRY_EXPIRED The client was disconnected due to a transient exception, but the retry policy expired before a connection could be re-established.

Method Summary

Modifier and Type	Method and Description
static IotHubConnectionStatusChangeReason	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IotHubConnectionStatusChangeReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EXPIRED_SAS_TOKEN

public static final IotHubConnectionStatusChangeReason EXPIRED_SAS_TOKEN

The SAS token associated with the client has expired, and cannot be renewed. The supplied credentials need to be fixed before a connection can be established.

This is returned with a connection status of IotHubConnectionStatus.DISCONNECTED.

BAD_CREDENTIAL

public static final IotHubConnectionStatusChangeReason BAD_CREDENTIAL

Incorrect credentials were supplied to the client instance. The supplied credentials need to be fixed before a connection can be established.

This is returned with a connection status of IotHubConnectionStatus.DISCONNECTED.

RETRY_EXPIRED

public static final IotHubConnectionStatusChangeReason RETRY_EXPIRED

The client was disconnected due to a transient exception, but the retry policy expired before a connection could be re-established. If you want to perform more operations on the device client, you should DeviceClient.close() and then DeviceClient.open(boolean) the client.

This is returned with a connection status of IotHubConnectionStatus.DISCONNECTED.

NO_NETWORK

public static final IotHubConnectionStatusChangeReason NO_NETWORK

The client was disconnected due to loss of network, the client will attempt for recovery.

This is returned with a connection status of IotHubConnectionStatus.DISCONNECTED_RETRYING.

COMMUNICATION_ERROR

public static final IotHubConnectionStatusChangeReason COMMUNICATION_ERROR

This can be returned with either a connection status of IotHubConnectionStatus.DISCONNECTED or IotHubConnectionStatus.DISCONNECTED_RETRYING.

When returned with a connection status of IotHubConnectionStatus.DISCONNECTED_RETRYING, this signifies that the client is trying to recover from a disconnect due to a transient exception. Do NOT close or open the client instance. Once the client successfully reports IotHubConnectionStatus.CONNECTED, operations will be resumed.

When returned with a connection status of IotHubConnectionStatus.DISCONNECTED, this signifies that client is disconnected due to a non-retryable exception. You should inspect the throwable supplied in the IotHubConnectionStatusChangeCallback to determine what action needs to be taken. If you want to perform more operations on the device client, you should DeviceClient.close() and then DeviceClient.open(boolean) the client.

CONNECTION_OK

public static final IotHubConnectionStatusChangeReason CONNECTION_OK

The client is connected, and ready to be used.

This is returned with a connection status of IotHubConnectionStatus.CONNECTED.

CLIENT_CLOSE

public static final IotHubConnectionStatusChangeReason CLIENT_CLOSE

The client has been closed gracefully.

This is returned with a connection status of IotHubConnectionStatus.DISCONNECTED.

Method Detail

values

public static IotHubConnectionStatusChangeReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IotHubConnectionStatusChangeReason c : IotHubConnectionStatusChangeReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IotHubConnectionStatusChangeReason valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null