buzz.getcoco.iot

Enum CapabilityTunnel.State

java.lang.Object

java.lang.Enum<CapabilityTunnel.State>

buzz.getcoco.iot.CapabilityTunnel.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<CapabilityTunnel.State>

Enclosing class:

CapabilityTunnel

public static enum CapabilityTunnel.State
extends java.lang.Enum<CapabilityTunnel.State>

enum denoting possible values for tunnel state. CapabilityTunnel.TunnelStatusListener.onStatusChanged(long, int, CapabilityTunnel.State)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE_FAILED Status on failure of closure of tunnel.
CLOSED Status on successful closure of tunnel.
MAX_CLIENT_REACHED Status on inability to open tunnel after max client count is reached.
OPEN_FAILED Status on failure of opening.
OPENED Status on successful opening of the tunnel.
OPENING Status on pending opening of the tunnel.
REOPENED Status on reopening of the tunnel.
TIMEOUT Status on timeout of the open or closed commands.

Method Summary

Modifier and Type	Method and Description
static boolean	isClosed(CapabilityTunnel.State state) A function to check if tunnel state is closed.
static boolean	isOpen(CapabilityTunnel.State state) A function to check if tunnel state is open.
static boolean	isOpeningOrOpened(CapabilityTunnel.State state) A function to check if tunnel state is opening or opened.
static CapabilityTunnel.State	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CapabilityTunnel.State[]	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

OPENING

public static final CapabilityTunnel.State OPENING

Status on pending opening of the tunnel.

OPENED

public static final CapabilityTunnel.State OPENED

Status on successful opening of the tunnel.

REOPENED

public static final CapabilityTunnel.State REOPENED

Status on reopening of the tunnel.

OPEN_FAILED

public static final CapabilityTunnel.State OPEN_FAILED

Status on failure of opening.

CLOSED

public static final CapabilityTunnel.State CLOSED

Status on successful closure of tunnel.

CLOSE_FAILED

public static final CapabilityTunnel.State CLOSE_FAILED

Status on failure of closure of tunnel.

TIMEOUT

public static final CapabilityTunnel.State TIMEOUT

Status on timeout of the open or closed commands.

MAX_CLIENT_REACHED

public static final CapabilityTunnel.State MAX_CLIENT_REACHED

Status on inability to open tunnel after max client count is reached.

Method Detail

values

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

Returns:

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

valueOf

public static CapabilityTunnel.State 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

isOpen

public static boolean isOpen(CapabilityTunnel.State state)

A function to check if tunnel state is open.

Parameters:

state - The enum denoting the state of the tunnel.

Returns:

True if open

isOpeningOrOpened

public static boolean isOpeningOrOpened(CapabilityTunnel.State state)

A function to check if tunnel state is opening or opened.

Parameters:

state - The enum denoting the state of the tunnel.

Returns:

True if opening/open/reopened

isClosed

public static boolean isClosed(CapabilityTunnel.State state)

A function to check if tunnel state is closed.

Parameters:

state - The enum denoting the state of the tunnel.

Returns:

True if closed/open_failed/timeout