org.jscsi.parser.datasegment

Interface IDataSegment

All Known Implementing Classes:

AbstractDataSegment

public interface IDataSegment

IDataSegment

This interface defines all methods, which a class must to support, if it is a DataSegment.

Author:

Volker Wildi

Method Summary

Methods

Modifier and Type	Method and Description
int	append(ByteBuffer src, int len) This method appends len bytes from the given ByteBuffer at the end of the data buffer of this instance.
void	clear() Clears all made settings of this object.
int	deserialize(ByteBuffer src, int len) Deprecated.
int	getLength() Returns the length, which is really used by the dataBuffer.
SettingsMap	getSettings() Returns a SettingsMap instance of this IDataSegment instance.
IDataSegmentIterator	iterator() Returns an iterator over the chunks of this data segment in proper sequence.
int	serialize(ByteBuffer dst, int off) Deprecated.
int	setDataBuffer(ByteBuffer src, int off, int len) Sets the data buffer to the given buffer src.

Method Detail

deserialize

@Deprecated
int deserialize(ByteBuffer src,
                         int len)

Deprecated.

This method imports len bytes from the given ByteBuffer.

Parameters:

src - Source ByteBuffer object.

len - The number of bytes to import from src.

Returns:

The number of bytes, which are imported. Typically, this should be equal as len.

append

int append(ByteBuffer src,
         int len)

This method appends len bytes from the given ByteBuffer at the end of the data buffer of this instance.

Parameters:

src - Source ByteBuffer object.

len - The number of bytes to append from src.

Returns:

The number of bytes of the complete data buffer of this instance.

serialize

@Deprecated
int serialize(ByteBuffer dst,
                       int off)

Deprecated.

This method exports the data buffer to the given ByteBuffer object, which is padded to a integer number of 4 byte words.

Parameters:

dst - Destination ByteBuffer object.

off - Start position in dst, where to serialize.

Returns:

The number of exported bytes (in bytes).

iterator

IDataSegmentIterator iterator()

Returns an iterator over the chunks of this data segment in proper sequence.

Returns:

an iterator over the chunks of this data segment in proper sequence.

getSettings

SettingsMap getSettings()
                        throws InternetSCSIException

Returns a SettingsMap instance of this IDataSegment instance. This is only useful with a TextParameterDataSegment instance.

Returns:

The settings of this TextParameterDataSegment instance.

Throws:

InternetSCSIException - if any violation of the iSCSI Standard occurs.

clear

void clear()

Clears all made settings of this object. After the call of this method, this object can be reused.

getLength

int getLength()

Returns the length, which is really used by the dataBuffer.

Returns:

The really used length.

setDataBuffer

int setDataBuffer(ByteBuffer src,
                int off,
                int len)

Sets the data buffer to the given buffer src. Starting from the position offset with length of len.

Parameters:

src - The buffer to read from.

off - The start offset to read from.

len - The number of bytes to read.

Returns:

The number of bytes really read.