org.jscsi.target.scsi

Class ScsiResponseDataSegment

java.lang.Object

org.jscsi.target.scsi.ScsiResponseDataSegment

public final class ScsiResponseDataSegment
extends Object

Instances of this class represent data that may be sent in a SCSI Command Response PDU.

It may contain either SenseData, IResponseData, or (rarely) both. Some SCSI commands require that no response data is sent (i.e. data segment length = 0) - in these cases the EMPTY_DATA_SEGMENT shall be used.

Since the target must honor the buffer size the initiator has allocated for data returned in the data segment, the serialize() method will only write as many bytes to the passed ByteBuffer as specified during initialization.

Author:

Andreas Ergenzinger

See Also:

TargetPduFactory

Field Summary

Fields

Modifier and Type	Field and Description
static ScsiResponseDataSegment	EMPTY_DATA_SEGMENT A ScsiResponseDataSegment of length zero.

Constructor Summary

Constructors

Constructor and Description
ScsiResponseDataSegment(IResponseData responseData, int allocationLength) Creates a ScsiResponseDataSegment with IResponseData.
ScsiResponseDataSegment(SenseData senseData, int allocationLength) Creates a ScsiResponseDataSegment with SenseData.

Method Summary

Methods

Modifier and Type	Method and Description
int	getResidualCount() Returns the number of bytes that had to be cropped due to the total length of all contained fields exceeding the allocationLength.
boolean	getResidualOverflow() Indicates if any bytes have to be cropped during serialize() calls.
ByteBuffer	serialize() Returns a ByteBuffer containing a serialized representation of this object.
int	uncroppedSize() The length of the ScsiResponseDataSegment, without considering any limitations due to allocationLength.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_DATA_SEGMENT

public static final ScsiResponseDataSegment EMPTY_DATA_SEGMENT

A ScsiResponseDataSegment of length zero.

Constructor Detail

ScsiResponseDataSegment

public ScsiResponseDataSegment(SenseData senseData,
                       int allocationLength)

Creates a ScsiResponseDataSegment with SenseData.

Parameters:

senseData - the sense data sent as the result of SCSI error

allocationLength - number of bytes the initiator has allocated for data sent in the data segment

ScsiResponseDataSegment

public ScsiResponseDataSegment(IResponseData responseData,
                       int allocationLength)

Creates a ScsiResponseDataSegment with IResponseData.

Parameters:

responseData - the data requested by the initiator

allocationLength - number of bytes the initiator has allocated for data sent in the data segment

Method Detail

serialize

public ByteBuffer serialize()

Returns a ByteBuffer containing a serialized representation of this object.

Returns:

a ByteBuffer containing a serialized representation of this object

uncroppedSize

public int uncroppedSize()

The length of the ScsiResponseDataSegment, without considering any limitations due to allocationLength.

The returned value is calculated just once, and then stored in uncroppedSize. This summation is performed only if uncroppedSize is negative.

Returns:

length of the ScsiResponseDataSegment, without considering any limitations due to allocationLength

getResidualOverflow

public boolean getResidualOverflow()

Indicates if any bytes have to be cropped during serialize() calls. The method returns true if and only if the serialized length of this objects exceeds allocationLength.

Returns:

true if and only if the serialized length of this objects exceeds allocationLength

getResidualCount

public int getResidualCount()

Returns the number of bytes that had to be cropped due to the total length of all contained fields exceeding the allocationLength.

Returns:

the total number of bytes that have to be cropped during serialization

See Also:

serialize()