com.hazelcast.collection.impl.txnqueue.operations

Class TxnReserveOfferOperation

java.lang.Object

com.hazelcast.spi.Operation

com.hazelcast.spi.impl.AbstractNamedOperation

com.hazelcast.collection.impl.queue.operations.QueueOperation

com.hazelcast.collection.impl.queue.operations.QueueBackupAwareOperation

com.hazelcast.collection.impl.txnqueue.operations.TxnReserveOfferOperation

All Implemented Interfaces:

DataSerializable, IdentifiedDataSerializable, BackupAwareOperation, BlockingOperation, MutatingOperation, NamedOperation, PartitionAwareOperation

public class TxnReserveOfferOperation
extends QueueBackupAwareOperation
implements BlockingOperation, MutatingOperation

Transaction prepare operation for a queue offer, executed on the primary replica.

Checks if the queue can accomodate one more item in addition to the number provided to the constructor and returns the next item ID. This check is done on a scope of one transaction and does not include other transactions. It can also happen that after this check succeeds, the user will add more items to the queue which means that the queue can no longer accomodate for the items for which it has returned an item ID.

The operation can also wait until there is enough room or the wait timeout has elapsed.

See Also:

TransactionalQueue.offer(Object), TxnOfferOperation

Field Summary

Fields inherited from class com.hazelcast.collection.impl.queue.operations.QueueOperation

response

Fields inherited from class com.hazelcast.spi.impl.AbstractNamedOperation

name

Fields inherited from class com.hazelcast.spi.Operation

GENERIC_PARTITION_ID

Constructor Summary

Constructors

Constructor and Description
TxnReserveOfferOperation()
TxnReserveOfferOperation(String name, long timeoutMillis, int txSize, String transactionId)

Method Summary

Modifier and Type	Method and Description
Operation	getBackupOperation() Creates the BackupOperation responsible for making the backup.
int	getId() Returns type identifier for this class.
WaitNotifyKey	getWaitKey()
void	onWaitExpire()
protected void	readInternal(ObjectDataInput in)
void	run() Runs the operation.
boolean	shouldBackup() Checks if a backup needs to be made.
boolean	shouldWait()
protected void	writeInternal(ObjectDataOutput out)

Methods inherited from class com.hazelcast.collection.impl.queue.operations.QueueBackupAwareOperation

getAsyncBackupCount, getSyncBackupCount

Methods inherited from class com.hazelcast.collection.impl.queue.operations.QueueOperation

afterRun, beforeRun, getContainer, getFactoryId, getQueueService, getResponse, getServiceName, hasListener, publishEvent

Methods inherited from class com.hazelcast.spi.impl.AbstractNamedOperation

getName, toString

Methods inherited from class com.hazelcast.spi.Operation

call, executedLocally, getCallerAddress, getCallerUuid, getCallId, getCallTimeout, getConnection, getInvocationTime, getLogger, getNodeEngine, getOperationResponseHandler, getPartitionId, getReplicaIndex, getService, getWaitTimeout, isUrgent, logError, onExecutionFailure, onInvocationException, onSetCallId, readData, requiresExplicitServiceName, returnsResponse, sendResponse, setCallerUuid, setNodeEngine, setOperationResponseHandler, setPartitionId, setReplicaIndex, setService, setServiceName, setValidateTarget, setWaitTimeout, toString, validatesTarget, writeData

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hazelcast.spi.BlockingOperation

getWaitTimeout

Methods inherited from interface com.hazelcast.spi.PartitionAwareOperation

getPartitionId

Methods inherited from interface com.hazelcast.nio.serialization.DataSerializable

readData, writeData

Methods inherited from interface com.hazelcast.spi.NamedOperation

getName

Constructor Detail

TxnReserveOfferOperation

public TxnReserveOfferOperation()

TxnReserveOfferOperation

public TxnReserveOfferOperation(String name,
                                long timeoutMillis,
                                int txSize,
                                String transactionId)

Method Detail

run

public void run()
         throws Exception

Runs the operation. Either the Operation.run() or Operation.call() method should be implemented; not both. Runs after wait-support, supposed to do actual operation Sets the response to the next item ID if the queue can accomodate txSize + 1 items.

Overrides:

run in class Operation

Throws:

Exception

See Also:

Operation.call()

getWaitKey

public WaitNotifyKey getWaitKey()

Specified by:

getWaitKey in interface BlockingOperation

shouldWait

public boolean shouldWait()

Specified by:

shouldWait in interface BlockingOperation

onWaitExpire

public void onWaitExpire()

Specified by:

onWaitExpire in interface BlockingOperation

shouldBackup

public boolean shouldBackup()

Description copied from interface: BackupAwareOperation

Checks if a backup needs to be made.

If a call has not made any change, e.g. an AtomicLong increment with 0, no backup needs to be made.

Specified by:

shouldBackup in interface BackupAwareOperation

Returns:

true if a backup needs to be made, false otherwise.

getBackupOperation

public Operation getBackupOperation()

Description copied from interface: BackupAwareOperation

Creates the BackupOperation responsible for making the backup.

Specified by:

getBackupOperation in interface BackupAwareOperation

Returns:

the created BackupOperation responsible for making the backup.

getId

public int getId()

Description copied from interface: IdentifiedDataSerializable

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

Specified by:

getId in interface IdentifiedDataSerializable

Returns:

type ID

writeInternal

protected void writeInternal(ObjectDataOutput out)
                      throws IOException

Overrides:

writeInternal in class AbstractNamedOperation

Throws:

IOException

readInternal

protected void readInternal(ObjectDataInput in)
                     throws IOException

Overrides:

readInternal in class AbstractNamedOperation

Throws:

IOException