com.hazelcast.spi.impl.operationservice.impl.responses

Class NormalResponse

java.lang.Object

com.hazelcast.spi.impl.operationservice.impl.responses.Response

com.hazelcast.spi.impl.operationservice.impl.responses.NormalResponse

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable

public class NormalResponse
extends Response

A NormalResponse is send when an Operation needs to return a value. This response value can a 'normal' value, but it can also contain the exception thrown.

Currently there is a limitation in the design that needs to be dealt with in the future: there is no distinction made between an exception thrown or an exception returned as a regular value. In such a case, Hazelcast will always rethrow the exception.

The NormalResponse contains the actual 'value' but also the callid of that operation and the backup count. Based on the backup count, the invoker of the operation knows when all the backups have completed.

Author:

mdogan 4/10/13

Field Summary

Fields

Modifier and Type	Field and Description
static int	OFFSET_BACKUP_ACKS
static int	OFFSET_DATA_LENGTH
static int	OFFSET_DATA_PAYLOAD
static int	OFFSET_IS_DATA
static int	OFFSET_NOT_DATA

Fields inherited from class com.hazelcast.spi.impl.operationservice.impl.responses.Response

callId, OFFSET_CALL_ID, OFFSET_IDENTIFIED, OFFSET_SERIALIZER_TYPE_ID, OFFSET_TYPE_FACTORY_ID, OFFSET_TYPE_ID, OFFSET_URGENT, RESPONSE_SIZE_IN_BYTES, urgent

Constructor Summary

Constructors

Constructor and Description
NormalResponse()
NormalResponse(Object value, long callId, int backupAcks, boolean urgent)

Method Summary

Modifier and Type	Method and Description
int	getBackupAcks() Returns the number of backups that needs to acknowledge before the invocation completes.
int	getId() Returns type identifier for this class.
Object	getValue() Returns the object value of the operation.
void	readData(ObjectDataInput in) Reads fields from the input stream
String	toString()
void	writeData(ObjectDataOutput out) Writes object fields to output stream

Methods inherited from class com.hazelcast.spi.impl.operationservice.impl.responses.Response

getCallId, getFactoryId, isUrgent

Methods inherited from class java.lang.Object

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

Field Detail

OFFSET_BACKUP_ACKS

public static final int OFFSET_BACKUP_ACKS

See Also:

Constant Field Values

OFFSET_IS_DATA

public static final int OFFSET_IS_DATA

See Also:

Constant Field Values

OFFSET_NOT_DATA

public static final int OFFSET_NOT_DATA

See Also:

Constant Field Values

OFFSET_DATA_LENGTH

public static final int OFFSET_DATA_LENGTH

See Also:

Constant Field Values

OFFSET_DATA_PAYLOAD

public static final int OFFSET_DATA_PAYLOAD

See Also:

Constant Field Values

Constructor Detail

NormalResponse

public NormalResponse()

NormalResponse

public NormalResponse(Object value,
                      long callId,
                      int backupAcks,
                      boolean urgent)

Method Detail

getValue

public Object getValue()

Returns the object value of the operation.

Returns:

The object value.

getBackupAcks

public int getBackupAcks()

Returns the number of backups that needs to acknowledge before the invocation completes.

Returns:

The number of backup acknowledgements backups.

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

Returns type identifier for this class. It should be unique per DataSerializableFactory.

Returns:

type ID

writeData

public void writeData(ObjectDataOutput out)
               throws IOException

Description copied from interface: DataSerializable

Writes object fields to output stream

Specified by:

writeData in interface DataSerializable

Overrides:

writeData in class Response

Parameters:

out - output

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the output stream has been closed.

readData

public void readData(ObjectDataInput in)
              throws IOException

Description copied from interface: DataSerializable

Reads fields from the input stream

Specified by:

readData in interface DataSerializable

Overrides:

readData in class Response

Parameters:

in - input

Throws:

IOException - if an I/O error occurs. In particular, an IOException may be thrown if the input stream has been closed.

toString

public String toString()

Overrides:

toString in class Object