org.jscsi.parser.asynchronous

Enum AsynchronousMessageParser.AsyncEventCodes

java.lang.Object

java.lang.Enum<AsynchronousMessageParser.AsyncEventCodes>

org.jscsi.parser.asynchronous.AsynchronousMessageParser.AsyncEventCodes

All Implemented Interfaces:

Serializable, Comparable<AsynchronousMessageParser.AsyncEventCodes>

Enclosing class:

AsynchronousMessageParser

public static enum AsynchronousMessageParser.AsyncEventCodes
extends Enum<AsynchronousMessageParser.AsyncEventCodes>

Enumeration of all valid asynchronous message event codes.

Event Code	Description
0	A SCSI Asynchronous Event is reported in the sense data. Sense Data that accompanies the report, in the data segment, identifies the condition. The sending of a SCSI Event (Asynchronous Event Reporting in SCSI terminology) is dependent on the target support for SCSI asynchronous event reporting (see [SAM2]) as indicated in the standard INQUIRY data (see [SPC3]). Its use may be enabled by parameters in the SCSI Control mode page (see [SPC3]).
1	Target requests Logout. This Async Message MUST be sent on the same connection as the one requesting to be logged out. The initiator MUST honor this request by issuing a Logout as early as possible, but no later than Parameter3 seconds. Initiator MUST send a Logout with a reason code of "Close the connection" OR "Close the session" to close all the connections. Once this message is received, the initiator SHOULD NOT issue new iSCSI commands on the connection to be logged out. The target MAY reject any new I/O requests that it receives after this Message with the reason code "Waiting for Logout". If the initiator does not Logout in Parameter3 seconds, the target should send an Async PDU with iSCSI event code "Dropped the connection" if possible, or simply terminate the transport connection. Parameter1 and Parameter2 are reserved.
2	Target indicates it will drop the connection. The Parameter1 field indicates the CID of the connection that is going to be dropped. The Parameter2 field (Time2Wait) indicates, in seconds, the minimum time to wait before attempting to reconnect or reassign. The Parameter3 field (Time2Retain) indicates the maximum time allowed to reassign commands after the initial wait (in Parameter2). If the initiator does not attempt to reconnect and/or reassign the outstanding commands within the time specified by Parameter3, or if Parameter3 is 0, the target will terminate all outstanding commands on this connection. In this case, no other responses should be expected from the target for the outstanding commands on this connection. A value of 0 for Parameter2 indicates that reconnect can be attempted immediately.
3	Target indicates it will drop all the connections of this session. Parameter1 field is reserved. The Parameter2 field (Time2Wait) indicates, in seconds, the minimum time to wait before attempting to reconnect. The Parameter3 field (Time2Retain) indicates the maximum time allowed to reassign commands after the initial wait (in Parameter2). If the initiator does not attempt to reconnect and/or reassign the outstanding commands within the time specified by Parameter3, or if Parameter3 is 0, the session is terminated. In this case, the target will terminate all outstanding commands in this session; no other responses should be expected from the target for the outstanding commands in this session. A value of 0 for Parameter2 indicates that reconnect can be attempted immediately.
4	Target requests parameter negotiation on this connection. The initiator MUST honor this request by issuing a Text Request (that can be empty) on the same connection as early as possible, but no later than Parameter3 seconds, unless a Text Request is already pending on the connection, or by issuing a Logout Request. If the initiator does not issue a Text Request the target may reissue the Asynchronous Message requesting parameter negotiation.
255	Vendor specific iSCSI Event. The AsyncVCode details the vendor code, and data MAY accompany the report.

All other event codes are reserved.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DROP_ALL_CONNECTIONS Target indicates it will drop all the connections of this session.
DROP_CONNECTION Target indicates it will drop the connection.
LOGOUT Target requests Logout.
PARAMETER_NEGOTIATION Target requests parameter negotiation on this connection.
SCSI_ASYNCHRONOUS_EVENT A SCSI Asynchronous Event is reported in the sense data.
VENDOR_SPECIFIC_EVENT Vendor specific iSCSI Event.

Method Summary

Methods

Modifier and Type	Method and Description
byte	value() Returns the value of this enumeration.
static AsynchronousMessageParser.AsyncEventCodes	valueOf(byte value) Returns the constant defined for the given value.
static AsynchronousMessageParser.AsyncEventCodes	valueOf(String name) Returns the enum constant of this type with the specified name.
static AsynchronousMessageParser.AsyncEventCodes[]	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

SCSI_ASYNCHRONOUS_EVENT

public static final AsynchronousMessageParser.AsyncEventCodes SCSI_ASYNCHRONOUS_EVENT

A SCSI Asynchronous Event is reported in the sense data.

LOGOUT

public static final AsynchronousMessageParser.AsyncEventCodes LOGOUT

Target requests Logout.

DROP_CONNECTION

public static final AsynchronousMessageParser.AsyncEventCodes DROP_CONNECTION

Target indicates it will drop the connection.

DROP_ALL_CONNECTIONS

public static final AsynchronousMessageParser.AsyncEventCodes DROP_ALL_CONNECTIONS

Target indicates it will drop all the connections of this session.

PARAMETER_NEGOTIATION

public static final AsynchronousMessageParser.AsyncEventCodes PARAMETER_NEGOTIATION

Target requests parameter negotiation on this connection.

VENDOR_SPECIFIC_EVENT

public static final AsynchronousMessageParser.AsyncEventCodes VENDOR_SPECIFIC_EVENT

Vendor specific iSCSI Event.

Method Detail

values

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

Returns:

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

valueOf

public static AsynchronousMessageParser.AsyncEventCodes 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

value

public final byte value()

Returns the value of this enumeration.

Returns:

The value of this enumeration.

valueOf

public static final AsynchronousMessageParser.AsyncEventCodes valueOf(byte value)

Returns the constant defined for the given value.

Parameters:

value - The value to search for.

Returns:

The constant defined for the given value. Or null, if this value is not defined by this enumeration.