com.hazelcast.collection.impl.txnqueue

Class TransactionalQueueProxy<E>

java.lang.Object

com.hazelcast.spi.AbstractDistributedObject<S>

com.hazelcast.spi.TransactionalDistributedObject<QueueService>

com.hazelcast.collection.impl.txnqueue.TransactionalQueueProxySupport<E>

com.hazelcast.collection.impl.txnqueue.TransactionalQueueProxy<E>

Type Parameters:

E -

All Implemented Interfaces:

BaseQueue<E>, DistributedObject, TransactionalQueue<E>, TransactionalObject

public class TransactionalQueueProxy<E>
extends TransactionalQueueProxySupport<E>

Provides proxy for the Transactional Queue.

Field Summary

Fields inherited from class com.hazelcast.collection.impl.txnqueue.TransactionalQueueProxySupport

config, name, partitionId

Fields inherited from class com.hazelcast.spi.TransactionalDistributedObject

tx

Fields inherited from class com.hazelcast.spi.AbstractDistributedObject

PARTITIONING_STRATEGY

Constructor Summary

Constructors

Constructor and Description
TransactionalQueueProxy(NodeEngine nodeEngine, QueueService service, String name, Transaction tx)

Method Summary

Modifier and Type	Method and Description
boolean	offer(E e) Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions.
boolean	offer(E e, long timeout, TimeUnit unit) Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
E	peek()
E	peek(long timeout, TimeUnit unit)
E	poll() Retrieves and removes the head of this queue, or returns null if this queue is empty.
E	poll(long timeout, TimeUnit unit) Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
E	take() Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.
String	toString()

Methods inherited from class com.hazelcast.collection.impl.txnqueue.TransactionalQueueProxySupport

getName, getServiceName, size

Methods inherited from class com.hazelcast.spi.TransactionalDistributedObject

toObjectIfNeeded

Methods inherited from class com.hazelcast.spi.AbstractDistributedObject

destroy, equals, getDistributedObjectName, getNameAsPartitionAwareData, getNodeEngine, getOperationService, getPartitionId, getPartitionKey, getService, hashCode, invalidate, invokeOnPartition, postDestroy, preDestroy, throwNotActiveException, toData

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hazelcast.core.DistributedObject

destroy, getPartitionKey

Constructor Detail

TransactionalQueueProxy

public TransactionalQueueProxy(NodeEngine nodeEngine,
                               QueueService service,
                               String name,
                               Transaction tx)

Method Detail

offer

public boolean offer(E e)

Description copied from interface: TransactionalQueue

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions. Returns true upon success and false if no space is currently available.

Parameters:

e - the element to add

Returns:

true if the element was added to this queue, false otherwise

offer

public boolean offer(E e,
                     long timeout,
                     TimeUnit unit)
              throws InterruptedException

Description copied from interface: TransactionalQueue

Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.

Parameters:

e - the element to add

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determines how to interpret the timeout parameter

Returns:

true if successful, or false if the specified waiting time elapses before space is available

Throws:

InterruptedException - if interrupted while waiting

take

public E take()
       throws InterruptedException

Description copied from interface: TransactionalQueue

Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Returns:

the head of this queue

Throws:

InterruptedException - if interrupted while waiting

poll

public E poll()

Description copied from interface: TransactionalQueue

Retrieves and removes the head of this queue, or returns null if this queue is empty.

Returns:

the head of this queue, or null if this queue is empty

poll

public E poll(long timeout,
              TimeUnit unit)
       throws InterruptedException

Description copied from interface: TransactionalQueue

Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head of this queue, or null if the specified waiting time elapses before an element is available

Throws:

InterruptedException - if interrupted while waiting

peek

public E peek()

Description copied from interface: TransactionalQueue

peek

public E peek(long timeout,
              TimeUnit unit)
       throws InterruptedException

Description copied from interface: TransactionalQueue

Throws:

InterruptedException

toString

public String toString()

Overrides:

toString in class AbstractDistributedObject<QueueService>