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

Enum IotHubConnectionStatus

java.lang.Object

java.lang.Enum<IotHubConnectionStatus>

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

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONNECTED The device or module is connected.
DISCONNECTED The device or module is disconnected.
DISCONNECTED_RETRYING The device or module is attempting to reconnect.

Method Summary

Modifier and Type	Method and Description
static IotHubConnectionStatus	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static IotHubConnectionStatus[]	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

CONNECTED

public static final IotHubConnectionStatus CONNECTED

The device or module is connected.

The client is connected, and ready to be used.

DISCONNECTED

public static final IotHubConnectionStatus DISCONNECTED

The device or module is disconnected.

Inspect the associated IotHubConnectionStatusChangeReason returned (and exception thrown, if any), and take appropriate action.

DISCONNECTED_RETRYING

public static final IotHubConnectionStatus DISCONNECTED_RETRYING

The device or module is attempting to reconnect.

The client is attempting to recover the connection. Do NOT close or open the client instance when it is retrying.

Method Detail

values

public static IotHubConnectionStatus[] 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 (IotHubConnectionStatus c : IotHubConnectionStatus.values())
    System.out.println(c);

Returns:

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

valueOf

public static IotHubConnectionStatus 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