org.jscsi.target.scsi

Interface ISerializable

All Known Subinterfaces:

IResponseData

All Known Implementing Classes:

ActualRetryCountSenseKeySpecificData, AdditionalSenseBytes, CachingModePage, CommandSpecificSenseDataDescriptor, DescriptorFormatSenseData, DeviceIdentificationVpdPage, EightByteInformation, FieldPointerSenseKeySpecificData, FixedFormatSenseData, FourByteInformation, IdentificationDescriptor, Identifier, Information, InformationExceptionsControlModePage, InformationSenseDataDescriptor, InvalidSenseKeySpecificData, LogicalBlockDescriptor, LogicalUnitNumber, LongLogicalBlockDescriptor, ModePage, ModeParameterHeader, ModeParameterHeader10, ModeParameterHeader6, ModeParameterList, Page_0FormatModePage, ProgressIndicationSenseKeySpecificData, ReadCapacity10ParameterData, ReadCapacity16ParameterData, ReadCapacityParameterData, ReportLunsParameterData, ScsiNameStringIdentifier, SegmentPointerSenseKeySpecificData, SenseData, SenseDataDescriptor, SenseKeySpecificData, SenseKeySpecificSenseDataDescriptor, ShortLogicalBlockDescriptor, StandardInquiryData, SubPageFormatModePage, SupportedVpdPages

public interface ISerializable

This interface specifies methods for serializing an object. The serialized object can be inserted into an existing ByteBuffer of sufficient size at an arbitrary position.

This interface is implemented by the classes representing sense and response data (as well as components thereof) to SCSI requests, which are returned to the iSCSI initiator in the SCSI Response PDU's data segment.

Additional care must be taken when implementing objects consisting of several ISerializable components, not to overwrite the fields of another component. The advantage of this strategy, however, will be higher speed, since unnecessary buffer-to-buffer copying is avoided.

Author:

Andreas Ergenzinger

Method Summary

Methods

Modifier and Type	Method and Description
void	serialize(ByteBuffer byteBuffer, int index) Inserts a serialized representation of the object into the specified ByteBuffer.
int	size() Returns the size in bytes of the object's serialized representation.

Method Detail

serialize

void serialize(ByteBuffer byteBuffer,
             int index)

Inserts a serialized representation of the object into the specified ByteBuffer. The serialized object will occupy the byte positions from index to index + size() - 1.

Parameters:

byteBuffer - where to insert the serialized object representation

index - the position of the first byte of the serialized object in the ByteBuffer

size

int size()

Returns the size in bytes of the object's serialized representation.

Returns:

the size in bytes of the object's serialized representation