org.jscsi.target.connection

Class Connection.TargetConnection

java.lang.Object

org.jscsi.target.connection.Connection.TargetConnection

All Implemented Interfaces:

Callable<Void>, Connection

Enclosing interface:

Connection

public static class Connection.TargetConnection
extends Object
implements Connection

Nested Class Summary

Nested classes/interfaces inherited from interface org.jscsi.target.connection.Connection

Connection.TargetConnection

Constructor Summary

Constructors

Constructor and Description
Connection.TargetConnection(SocketChannel socketChannel, boolean isLeadingConnection) The Connection.TargetConnection constructor.

Method Summary

Methods

Modifier and Type	Method and Description
Void	call() Starts the processing of PDUs by this connection.
ConnectionSettingsNegotiator	getConnectionSettingsNegotiator()
byte[]	getDataInArray(int length) Returns a byte array that can be used for holding data segment data of Data In PDUs sent during the ReadStage.
Settings	getSettings() Returns a Settings object with a snapshot of the current connection and session parameters.
SerialArithmeticNumber	getStatusSequenceNumber()
TargetSession	getTargetSession()
void	initializeConnectionSettingsNegotiator(SessionSettingsNegotiator sessionSettingsNegotiator) Initializes connectionSettingsNegotiator.
boolean	isLeadingConnection() Returns true if this is the leading connection, i.e.
org.jscsi.parser.ProtocolDataUnit	receivePdu() Returns the next ProtocolDataUnit to be received on the connection.
void	sendPdu(org.jscsi.parser.ProtocolDataUnit pdu) Serializes and sends a ProtocolDataUnit over the connection.
void	setSession(TargetSession session) Sets the TargetSession this connection belongs to.
void	setStatusSequenceNumber(int statusSequenceNumber)
boolean	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

Connection.TargetConnection

public Connection.TargetConnection(SocketChannel socketChannel,
                           boolean isLeadingConnection)

The Connection.TargetConnection constructor.

Parameters:

socketChannel - used for sending and receiving PDUs

isLeadingConnection - true if and only if this connection is the first connection associated with its enclosing session

Method Detail

getDataInArray

public byte[] getDataInArray(int length)

Returns a byte array that can be used for holding data segment data of Data In PDUs sent during the ReadStage.

Specified by:

getDataInArray in interface Connection

Parameters:

length - the length of the array

Returns:

a byte array of the specified length

setSession

public void setSession(TargetSession session)

Sets the TargetSession this connection belongs to.

Specified by:

setSession in interface Connection

Parameters:

session - the TargetSession this connection belongs to

receivePdu

public org.jscsi.parser.ProtocolDataUnit receivePdu()
                                             throws DigestException,
                                                    org.jscsi.exception.InternetSCSIException,
                                                    IOException,
                                                    SettingsException

Returns the next ProtocolDataUnit to be received on the connection.

The method will block until a PDU has been completely received.

Specified by:

receivePdu in interface Connection

Returns:

the next received PDU

Throws:

DigestException - if a digest error has occured

org.jscsi.exception.InternetSCSIException - if a general iSCSI protocol error has been detected

IOException - if the connection was closed

SettingsException - will not happen

sendPdu

public void sendPdu(org.jscsi.parser.ProtocolDataUnit pdu)
             throws InterruptedException,
                    IOException,
                    org.jscsi.exception.InternetSCSIException

Serializes and sends a ProtocolDataUnit over the connection.

Specified by:

sendPdu in interface Connection

Parameters:

pdu - the PDU to send

Throws:

InterruptedException

IOException

org.jscsi.exception.InternetSCSIException

call

public Void call()

Starts the processing of PDUs by this connection.

For this method to work properly, the leading PDU send by the initiator over this connection must have been received via receivePdu().

Specified by:

call in interface Callable<Void>

getTargetSession

public TargetSession getTargetSession()

Specified by:

getTargetSession in interface Connection

isLeadingConnection

public boolean isLeadingConnection()

Returns true if this is the leading connection, i.e. the first TargetConnection in the connection's TargetSession. Otherwise false is returned.

Specified by:

isLeadingConnection in interface Connection

Returns:

true if this is the leading connection

initializeConnectionSettingsNegotiator

public void initializeConnectionSettingsNegotiator(SessionSettingsNegotiator sessionSettingsNegotiator)

Initializes connectionSettingsNegotiator.

This method must be be called after the this connection has been added to its session.

Specified by:

initializeConnectionSettingsNegotiator in interface Connection

getSettings

public Settings getSettings()

Returns a Settings object with a snapshot of the current connection and session parameters.

Specified by:

getSettings in interface Connection

Returns:

the current Settings

getConnectionSettingsNegotiator

public ConnectionSettingsNegotiator getConnectionSettingsNegotiator()

Specified by:

getConnectionSettingsNegotiator in interface Connection

getStatusSequenceNumber

public SerialArithmeticNumber getStatusSequenceNumber()

Specified by:

getStatusSequenceNumber in interface Connection

setStatusSequenceNumber

public void setStatusSequenceNumber(int statusSequenceNumber)

Specified by:

setStatusSequenceNumber in interface Connection

stop

public boolean stop()

Specified by:

stop in interface Connection