anon.client

Class DataChainSendOrderStructure

java.lang.Object

anon.client.DataChainSendOrderStructure

public class DataChainSendOrderStructure
extends java.lang.Object

Author:

Stefan Lieske

Constructor Summary

Constructors

Constructor and Description
DataChainSendOrderStructure(byte[] a_orderData)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getAdditionalProtocolData() Returns the additional protocol data as an Object type.
byte[]	getChannelCell() Returns the channel cell buffer, that will be transmitted over the channel.
byte[]	getOrderData()
int	getProcessedBytes() Returns the number of bytes of the order data, that have already been processed.
java.lang.Object	getSynchronizationObject() Returns the internal synchronization object.
java.io.IOException	getThrownException() Returns the exception that occurred while processing this order.
boolean	isProcessingDone() Returns whether or not the processing was finished on this order already.
void	processingDone() Declares the processing of this order as having finished and notifies threads waiting on it.
void	setAdditionalProtocolData(java.lang.Object a_protocolData) Sets any object as additional protocol data.
void	setChannelCell(byte[] a_channelCell) Set the channel cell byte buffer, that will be transmitted over the channel.
void	setProcessedBytes(int a_processedBytes) Set how many bytes of the order data have been processed already.
void	setThrownException(java.io.IOException a_thrownException) Sets the exception that occurred, when the processing of an order ended in an error.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataChainSendOrderStructure

public DataChainSendOrderStructure(byte[] a_orderData)

Method Detail

getOrderData

public byte[] getOrderData()

getAdditionalProtocolData

public java.lang.Object getAdditionalProtocolData()

Returns the additional protocol data as an Object type.

This needs to be cast to whatever type the protocol data is expected to be.

Returns:

protocol data as an Object, null if none was set

setAdditionalProtocolData

public void setAdditionalProtocolData(java.lang.Object a_protocolData)

Sets any object as additional protocol data.

Parameters:

a_protocolData - protocol data as Object

processingDone

public void processingDone()

Declares the processing of this order as having finished and notifies threads waiting on it.

See Also:

anon.client.DataChainSendOrderStructure#m_internalSynchronization m_internalSynchronization}, anon.client.DataChainSendOrderStructure#isProcessingDone() isProcessingDone()}, anon.client.DataChainSendOrderStructure#getSynchronizationObject() getSynchronizationObject()}

isProcessingDone

public boolean isProcessingDone()

Returns whether or not the processing was finished on this order already.

Returns:

true, if processing is finished, false otherwise

getSynchronizationObject

public java.lang.Object getSynchronizationObject()

Returns the internal synchronization object. Threads can wait on this object, to be notified when processing of this order was completed.

Returns:

the internal synchronization object

setThrownException

public void setThrownException(java.io.IOException a_thrownException)

Sets the exception that occurred, when the processing of an order ended in an error.

Parameters:

a_thrownException -

getThrownException

public java.io.IOException getThrownException()

Returns the exception that occurred while processing this order.

Returns:

the exception that occurred while processing this order.

setProcessedBytes

public void setProcessedBytes(int a_processedBytes)

Set how many bytes of the order data have been processed already.

Parameters:

a_processedBytes -

getProcessedBytes

public int getProcessedBytes()

Returns the number of bytes of the order data, that have already been processed.

Returns:

setChannelCell

public void setChannelCell(byte[] a_channelCell)

Set the channel cell byte buffer, that will be transmitted over the channel.

This is usually called by the data chain, when preparing the payload.

Parameters:

a_channelCell -

See Also:

anon.client.DataChainSendOrderStructure#m_channelCell m_channelCell}, anon.client.AbstractDataChain#createPacketPayload(DataChainSendOrderStructure)}

getChannelCell

public byte[] getChannelCell()

Returns the channel cell buffer, that will be transmitted over the channel.

Returns:

See Also:

anon.client.DataChainSendOrderStructure#m_channelCell m_channelCell}