org.jscsi.parser

Class BasicHeaderSegment

java.lang.Object

org.jscsi.parser.BasicHeaderSegment

public final class BasicHeaderSegment
extends Object

BasicHeaderSegment

This class encapsulate a Basic Header Segment (BHS), which is defined in the iSCSI Protocol (RFC3720). It provides methods for serializing or deserializing such an object. The contained data can be accessed seperately by the getter methods.

The BHS has a fixed size, which is stored in the variable BHS_FIXED_SIZE. And these must the first bytes in a valid iSCSI Protocol Data Unit (PDU). org.jscsi.utils

Author:

Volker Wildi

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
int	getDataSegmentLength() The Length of the Data Segment.
int	getInitiatorTaskTag() The initiator assigns a Task Tag to each iSCSI task it issues.
OperationCode	getOpCode() Returns the operation code, which is used in this BHS.
AbstractMessageParser	getParser() Returns a object of the used parser of this BHS.
byte	getTotalAHSLength() The length of the Additional Header Segment.
boolean	isFinalFlag() When this flag is set it indicates the final (or only) PDU of a sequence.
boolean	isImmediateFlag() For request PDUs, the immediate flag can be set as an immediate delivery marker.
void	setInitiatorTaskTag(int initInitiatorTaskTag) Changes the value of the initiator task tag.
String	toString() Creates a string object with all values for easy debugging.

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getDataSegmentLength

public final int getDataSegmentLength()

The Length of the Data Segment.

Returns:

length of the data segment

isFinalFlag

public final boolean isFinalFlag()

When this flag is set it indicates the final (or only) PDU of a sequence. In some kinds of messages (PDU) this methods has the meaning of the TransitFlag.

Returns:

The state of the final flag.

isImmediateFlag

public final boolean isImmediateFlag()

For request PDUs, the immediate flag can be set as an immediate delivery marker.

Returns:

The state of the immediate flag.

getInitiatorTaskTag

public final int getInitiatorTaskTag()

The initiator assigns a Task Tag to each iSCSI task it issues. While a task exists, this tag MUST uniquely identify the task session-wide. SCSI may also use the initiator task tag as part of the SCSI task identifier when the timespan during which an iSCSI initiator task tag must be unique extends over the timespan during which a SCSI task tag must be unique. However, the iSCSI Initiator Task Tag must exist and be unique even for untagged SCSI commands.

Returns:

the initiator task tag.

getTotalAHSLength

public final byte getTotalAHSLength()

The length of the Additional Header Segment.

Returns:

The length of the contained AHSs

getOpCode

public final OperationCode getOpCode()

Returns the operation code, which is used in this BHS.

Returns:

The operation code of this BHS.

getParser

public final AbstractMessageParser getParser()

Returns a object of the used parser of this BHS.

Returns:

The parser object to use for this PDU.

setInitiatorTaskTag

public final void setInitiatorTaskTag(int initInitiatorTaskTag)

Changes the value of the initiator task tag.

Parameters:

initInitiatorTaskTag - The new value of the initiator task tag.

toString

public final String toString()

Creates a string object with all values for easy debugging.

Overrides:

toString in class Object

Returns:

The string with all informations of this BHS.

equals

public final boolean equals(Object o)

Overrides:

equals in class Object