org.jscsi.parser.r2t

Class Ready2TransferParser

java.lang.Object

org.jscsi.parser.AbstractMessageParser

org.jscsi.parser.TargetMessageParser

org.jscsi.parser.r2t.Ready2TransferParser

public final class Ready2TransferParser
extends TargetMessageParser

This class parses a Ready2Transfer message defined in the iSCSI Standard (RFC3720).

Author:

Volker Wildi

Field Summary

Fields inherited from class org.jscsi.parser.TargetMessageParser

expectedCommandSequenceNumber, maximumCommandSequenceNumber, statusSequenceNumber

Fields inherited from class org.jscsi.parser.AbstractMessageParser

logicalUnitNumber, protocolDataUnit

Constructor Summary

Constructors

Constructor and Description
Ready2TransferParser(ProtocolDataUnit initProtocolDataUnit) Default constructor, creates a new, empty Ready2TransferParser object.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	checkIntegrity() This method checks, if all parsed fields are valid.
void	clear() This method sets all settings to their initial values.
protected void	deserializeBytes1to3(int line) Parse the bytes 1 till 3 in the Basic Header Segment.
protected void	deserializeBytes20to23(int line) Parse the bytes 20 till 23 in the Basic Header Segment.
protected void	deserializeBytes36to39(int line) Parse the bytes 36 till 39 in the Basic Header Segment.
protected void	deserializeBytes40to43(int line) Parse the bytes 40 till 43 in the Basic Header Segment.
protected void	deserializeBytes44to47(int line) Parse the bytes 44 till 47 in the Basic Header Segment.
int	getBufferOffset() The target specifies how many bytes it wants the initiator to send because of this R2T PDU.
DataSegmentFactory.DataSegmentFormat	getDataSegmentFormat() If this method returns true, hen it indicates that the data segment data is interpreted as binary data.
int	getDesiredDataTransferLength() The Desired Data Transfer Length MUST NOT be 0 and MUST not exceed MaxBurstLength.
int	getReady2TransferSequenceNumber() R2TSN is the R2T PDU input PDU number within the command identified by the Initiator Task Tag.
int	getTargetTransferTag() The target assigns its own tag to each R2T request that it sends to the initiator.
boolean	incrementSequenceNumber() This AbstractMessageParser instance affects the incrementation of the Expected Status Sequence Number.
protected int	serializeBytes20to23() Serializes the bytes 20 till 23 in the Basic Header Segment.
protected int	serializeBytes36to39() Serializes the bytes 36 till 39 in the Basic Header Segment.
protected int	serializeBytes40to43() Serializes the bytes 40 till 43 in the Basic Header Segment.
protected int	serializeBytes44to47() Serializes the bytes 44 till 47 in the Basic Header Segment.
void	setBufferOffset(int bufferOffset)
void	setDesiredDataTransferLength(int desiredDataTransferLength)
void	setReady2TransferSequenceNumber(int ready2TransferSequenceNumber)
void	setTargetTransferTag(int targetTransferTag)
String	toString() This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.

Methods inherited from class org.jscsi.parser.TargetMessageParser

deserializeBytes24to27, deserializeBytes28to31, deserializeBytes32to35, getExpectedCommandSequenceNumber, getMaximumCommandSequenceNumber, getShortInfo, getStatusSequenceNumber, serializeBytes1to3, serializeBytes24to27, serializeBytes28to31, serializeBytes32to35, setExpectedCommandSequenceNumber, setMaximumCommandSequenceNumber, setStatusSequenceNumber

Methods inherited from class org.jscsi.parser.AbstractMessageParser

canContainAdditionalHeaderSegments, canHaveDigests, deserializeBytes12to15, deserializeBytes8to11, getLogicalUnitNumber, serializeBytes12to15, serializeBytes8to11, setLogicalUnitNumber

Methods inherited from class java.lang.Object

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

Constructor Detail

Ready2TransferParser

public Ready2TransferParser(ProtocolDataUnit initProtocolDataUnit)

Default constructor, creates a new, empty Ready2TransferParser object.

Parameters:

initProtocolDataUnit - The reference ProtocolDataUnit instance, which contains this Ready2TransferParser subclass object.

Method Detail

toString

public final String toString()

This method concatenate all the fields of a derived parser to allow an easy generation of debug informations.

Overrides:

toString in class TargetMessageParser

Returns:

The debug formatted string.

getDataSegmentFormat

public final DataSegmentFactory.DataSegmentFormat getDataSegmentFormat()

If this method returns true, hen it indicates that the data segment data is interpreted as binary data. Else the data segment data must be interpreted as Text Format.

Specified by:

getDataSegmentFormat in class AbstractMessageParser

Returns:

Returns a format defined by the DataSegmentFormat enumeration.

See Also:

DataSegmentFactory.DataSegmentFormat

clear

public final void clear()

This method sets all settings to their initial values.

Overrides:

clear in class TargetMessageParser

incrementSequenceNumber

public final boolean incrementSequenceNumber()

This AbstractMessageParser instance affects the incrementation of the Expected Status Sequence Number.

Overrides:

incrementSequenceNumber in class TargetMessageParser

Returns:

true, if the counter has to be incremented. Else false.

getBufferOffset

public final int getBufferOffset()

The target specifies how many bytes it wants the initiator to send because of this R2T PDU. The target may request the data from the initiator in several chunks, not necessarily in the original order of the data. The target, therefore, also specifies a Buffer Offset that indicates the point at which the data transfer should begin, relative to the beginning of the total data transfer.

Returns:

The buffer offset of this object.

getDesiredDataTransferLength

public final int getDesiredDataTransferLength()

The Desired Data Transfer Length MUST NOT be 0 and MUST not exceed MaxBurstLength.

Returns:

The desired data transfer length of this object.

See Also:

getBufferOffset()

getReady2TransferSequenceNumber

public final int getReady2TransferSequenceNumber()

R2TSN is the R2T PDU input PDU number within the command identified by the Initiator Task Tag.
For bidirectional commands R2T and Data-In PDUs share the input PDU numbering sequence (see Section 3.2.2.3 Data Sequencing).

Returns:

The R2T Sequence Number of this object.

getTargetTransferTag

public final int getTargetTransferTag()

The target assigns its own tag to each R2T request that it sends to the initiator. This tag can be used by the target to easily identify the data it receives. The Target Transfer Tag and LUN are copied in the outgoing data PDUs and are only used by the target. There is no protocol rule about the Target Transfer Tag except that the value 0xffffffff is reserved and MUST NOT be sent by a target in an R2T.

Returns:

The target transfer tag of this object.

setTargetTransferTag

public final void setTargetTransferTag(int targetTransferTag)

setReady2TransferSequenceNumber

public final void setReady2TransferSequenceNumber(int ready2TransferSequenceNumber)

setBufferOffset

public final void setBufferOffset(int bufferOffset)

setDesiredDataTransferLength

public final void setDesiredDataTransferLength(int desiredDataTransferLength)

deserializeBytes1to3

protected final void deserializeBytes1to3(int line)
                                   throws InternetSCSIException

Parse the bytes 1 till 3 in the Basic Header Segment.

Overrides:

deserializeBytes1to3 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes20to23

protected final void deserializeBytes20to23(int line)
                                     throws InternetSCSIException

Parse the bytes 20 till 23 in the Basic Header Segment.

Overrides:

deserializeBytes20to23 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes36to39

protected final void deserializeBytes36to39(int line)
                                     throws InternetSCSIException

Parse the bytes 36 till 39 in the Basic Header Segment.

Overrides:

deserializeBytes36to39 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes40to43

protected final void deserializeBytes40to43(int line)
                                     throws InternetSCSIException

Parse the bytes 40 till 43 in the Basic Header Segment.

Overrides:

deserializeBytes40to43 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

deserializeBytes44to47

protected final void deserializeBytes44to47(int line)
                                     throws InternetSCSIException

Parse the bytes 44 till 47 in the Basic Header Segment.

Overrides:

deserializeBytes44to47 in class TargetMessageParser

Parameters:

line - The actual line

Throws:

InternetSCSIException - If any violation of the iSCSI-Standard emerge.

checkIntegrity

protected final void checkIntegrity()
                             throws InternetSCSIException

This method checks, if all parsed fields are valid. Because there are several fields, which are reserved for future versions, and these must be zero. Is this the case an exception will be thrown.

Specified by:

checkIntegrity in class AbstractMessageParser

Throws:

InternetSCSIException - If the integrity is violated.

serializeBytes20to23

protected final int serializeBytes20to23()

Serializes the bytes 20 till 23 in the Basic Header Segment.

Overrides:

serializeBytes20to23 in class TargetMessageParser

Returns:

The serialized byte representation.

serializeBytes36to39

protected final int serializeBytes36to39()

Serializes the bytes 36 till 39 in the Basic Header Segment.

Overrides:

serializeBytes36to39 in class TargetMessageParser

Returns:

The serialized byte representation.

serializeBytes40to43

protected final int serializeBytes40to43()

Serializes the bytes 40 till 43 in the Basic Header Segment.

Overrides:

serializeBytes40to43 in class TargetMessageParser

Returns:

The serialized byte representation.

serializeBytes44to47

protected final int serializeBytes44to47()

Serializes the bytes 44 till 47 in the Basic Header Segment.

Overrides:

serializeBytes44to47 in class TargetMessageParser

Returns:

The serialized byte representation.