com.hazelcast.collection.impl.queue.operations

Class PollOperation

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.queue.operations.PollOperation

All Implemented Interfaces:

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

public final class PollOperation
extends QueueBackupAwareOperation
implements BlockingOperation, Notifier, IdentifiedDataSerializable, MutatingOperation

Pool operation for Queue.

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
PollOperation()
PollOperation(String name, long timeoutMillis)

Method Summary

Modifier and Type	Method and Description
void	afterRun() Is executed called after Operation.run() or Operation.call() method completes normally and the operation is not blocked, see CallStatus.WAIT.
Operation	getBackupOperation() Creates the BackupOperation responsible for making the backup.
int	getFactoryId() Returns DataSerializableFactory factory ID for this class.
int	getId() Returns type identifier for this class.
WaitNotifyKey	getNotifiedKey()
WaitNotifyKey	getWaitKey()
void	onWaitExpire()
void	run() Runs the operation.
boolean	shouldBackup() Checks if a backup needs to be made.
boolean	shouldNotify()
boolean	shouldWait()

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

getAsyncBackupCount, getSyncBackupCount

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

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

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

getName, readInternal, toString, writeInternal

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.nio.serialization.DataSerializable

readData, writeData

Methods inherited from interface com.hazelcast.spi.PartitionAwareOperation

getPartitionId

Methods inherited from interface com.hazelcast.spi.NamedOperation

getName

Constructor Detail

PollOperation

public PollOperation()

PollOperation

public PollOperation(String name,
                     long timeoutMillis)

Method Detail

run

public void run()

Description copied from class: Operation

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

Overrides:

run in class Operation

See Also:

Operation.call()

afterRun

public void afterRun()
              throws Exception

Description copied from class: Operation

Is executed called after Operation.run() or Operation.call() method completes normally and the operation is not blocked, see CallStatus.WAIT. Runs after backups, before wait-notify.

Overrides:

afterRun in class QueueOperation

Throws:

Exception

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.

shouldNotify

public boolean shouldNotify()

Specified by:

shouldNotify in interface Notifier

getNotifiedKey

public WaitNotifyKey getNotifiedKey()

Specified by:

getNotifiedKey in interface Notifier

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

getFactoryId

public int getFactoryId()

Description copied from interface: IdentifiedDataSerializable

Returns DataSerializableFactory factory ID for this class.

Specified by:

getFactoryId in interface IdentifiedDataSerializable

Overrides:

getFactoryId in class QueueOperation

Returns:

factory ID

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