org.snf4j.core.engine

Enum HandshakeStatus

java.lang.Object

java.lang.Enum<HandshakeStatus>

org.snf4j.core.engine.HandshakeStatus

All Implemented Interfaces:

Serializable, Comparable<HandshakeStatus>

public enum HandshakeStatus
extends Enum<HandshakeStatus>

An enum describing the current handshaking state of an IEngine implementation.

Author:

SNF4J.ORG

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISHED An IEngine implementation has just finished handshaking.
NEED_TASK An IEngine implementation needs the results of one (or more) delegated tasks.
NEED_UNWRAP An IEngine implementation needs to receive data from the remote side.
NEED_UNWRAP_AGAIN An IEngine implementation is ready to unwrap data that has been previously received from the remote side.
NEED_WRAP An IEngine implementation must send data to the remote side.
NOT_HANDSHAKING An IEngine implementation is not currently handshaking.

Method Summary

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

FINISHED

public static final HandshakeStatus FINISHED

An IEngine implementation has just finished handshaking.

This value should be only generated by a call to IEngine.wrap(java.nio.ByteBuffer[], java.nio.ByteBuffer) or IEngine.unwrap(java.nio.ByteBuffer, java.nio.ByteBuffer) when that call finishes a handshake. It shouldn't be generated by IEngine.getHandshakeStatus().

NEED_TASK

public static final HandshakeStatus NEED_TASK

An IEngine implementation needs the results of one (or more) delegated tasks.

NEED_UNWRAP

public static final HandshakeStatus NEED_UNWRAP

An IEngine implementation needs to receive data from the remote side.

NEED_UNWRAP_AGAIN

public static final HandshakeStatus NEED_UNWRAP_AGAIN

An IEngine implementation is ready to unwrap data that has been previously received from the remote side. The data does not need to be received again.

NEED_WRAP

public static final HandshakeStatus NEED_WRAP

An IEngine implementation must send data to the remote side.

NOT_HANDSHAKING

public static final HandshakeStatus NOT_HANDSHAKING

An IEngine implementation is not currently handshaking.

Method Detail

values

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

Returns:

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

valueOf

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