com.neeve.link
Enum ILnkPeerEndpoint.State

java.lang.Object
  extended by java.lang.Enum<ILnkPeerEndpoint.State>
      extended by com.neeve.link.ILnkPeerEndpoint.State
All Implemented Interfaces:
Serializable, Comparable<ILnkPeerEndpoint.State>
Enclosing interface:
ILnkPeerEndpoint

public static enum ILnkPeerEndpoint.State
extends Enum<ILnkPeerEndpoint.State>

Specifies the peer endpoint states.


Enum Constant Summary
CLOSED
          Indicates that the endpoint has closed.
CLOSING
          Indicates that the endpoint is closing i.e. the endpoint close machinery has been kicked off by ILnkPeerEndpoint.close(short) but there is some endpoint operation (e.g. flush or read) that to be completed before the endpoint can transition the endpoint state to CLOSED.
CONNECTED
          Indicates that the link endpoint is connected and operational.
FAILED
          Indicates that the local endpoint has detected that the endpoint's peer has failed.
 
Method Summary
static ILnkPeerEndpoint.State valueOf(String name)
          Returns the enum constant of this type with the specified name.
static ILnkPeerEndpoint.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
compareTo, equals, 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 ILnkPeerEndpoint.State CONNECTED
Indicates that the link endpoint is connected and operational.


FAILED

public static final ILnkPeerEndpoint.State FAILED
Indicates that the local endpoint has detected that the endpoint's peer has failed.


CLOSING

public static final ILnkPeerEndpoint.State CLOSING
Indicates that the endpoint is closing i.e. the endpoint close machinery has been kicked off by ILnkPeerEndpoint.close(short) but there is some endpoint operation (e.g. flush or read) that to be completed before the endpoint can transition the endpoint state to CLOSED.

See Also:
ILnkPeerEndpoint.close(short)

CLOSED

public static final ILnkPeerEndpoint.State CLOSED
Indicates that the endpoint has closed.

Method Detail

values

public static ILnkPeerEndpoint.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 (ILnkPeerEndpoint.State c : ILnkPeerEndpoint.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 ILnkPeerEndpoint.State valueOf(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:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null


Copyright © 2015 Neeve Research, LLC. All Rights Reserved.