org.jscsi.parser.asynchronous

Class AsynchronousMessageParser

java.lang.Object

org.jscsi.parser.AbstractMessageParser

org.jscsi.parser.TargetMessageParser

org.jscsi.parser.asynchronous.AsynchronousMessageParser

public final class AsynchronousMessageParser
extends TargetMessageParser

AsynchronousMessageParser

Parser for the Asynchronous Message of the iSCSI Protocol (RFC3720).

Author:

Volker Wildi

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AsynchronousMessageParser.AsyncEventCodes Enumeration of all valid asynchronous message event codes.

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
AsynchronousMessageParser(ProtocolDataUnit initProtocolDataUnit) Default constructor, creates a new, empty AsynchronousMessageParser 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	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.
AsynchronousMessageParser.AsyncEventCodes	getAsyncEvent() Returns the asynchronous event code of this AsynchronousMessageParser object.
byte	getAsyncVCode() Returns the code of the iSCSI Asynchronous message.
DataSegmentFactory.DataSegmentFormat	getDataSegmentFormat() If this method returns true, hen it indicates that the data segment data is interpreted as binary data.
short	getParameter1() Returns the first parameter of this asynchronous message.
short	getParameter2() Returns the second parameter of this asynchronous message.
short	getParameter3() Returns the third parameter of this asynchronous message.
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.
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

deserializeBytes1to3, deserializeBytes20to23, deserializeBytes24to27, deserializeBytes28to31, deserializeBytes32to35, deserializeBytes44to47, getExpectedCommandSequenceNumber, getMaximumCommandSequenceNumber, getShortInfo, getStatusSequenceNumber, incrementSequenceNumber, serializeBytes1to3, serializeBytes20to23, serializeBytes24to27, serializeBytes28to31, serializeBytes32to35, serializeBytes44to47, 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

AsynchronousMessageParser

public AsynchronousMessageParser(ProtocolDataUnit initProtocolDataUnit)

Default constructor, creates a new, empty AsynchronousMessageParser object.

Parameters:

initProtocolDataUnit - The reference ProtocolDataUnit instance, which contains this AsynchronousMessageParser 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

getAsyncVCode

public final byte getAsyncVCode()

Returns the code of the iSCSI Asynchronous message.

AsyncVCode is a vendor specific detail code that is only valid if the AsyncEvent field indicates a vendor specific event. Otherwise, it is reserved.

Returns:

The Asynchronous vendor code.

See Also:

AsynchronousMessageParser.AsyncEventCodes

getAsyncEvent

public final AsynchronousMessageParser.AsyncEventCodes getAsyncEvent()

Returns the asynchronous event code of this AsynchronousMessageParser object.

Returns:

The asynchronous event.

getParameter1

public final short getParameter1()

Returns the first parameter of this asynchronous message.

Returns:

The first parameter.

getParameter2

public final short getParameter2()

Returns the second parameter of this asynchronous message.

Returns:

The second parameter.

getParameter3

public final short getParameter3()

Returns the third parameter of this asynchronous message.

Returns:

The third parameter.

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.

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.

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.