com.hazelcast.client.impl.protocol.template

Interface TransactionalQueueCodecTemplate

public interface TransactionalQueueCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	offer(String name, String txnId, long threadId, Data item, long timeout) Inserts the specified element into this queue, waiting up to the specified wait time if necessary for space to become available.
Object	peek(String name, String txnId, long threadId, long timeout) Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.
Object	poll(String name, String txnId, long threadId, long timeout) Retrieves and removes the head of this queue, waiting up to the specified wait time if necessary for an element to become available.
Object	size(String name, String txnId, long threadId) Returns the number of elements in this collection.If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.
Object	take(String name, String txnId, long threadId) Retrieves and removes the head of this queue, waiting if necessary until an element becomes available.

Method Detail

offer

Object offer(String name,
           String txnId,
           long threadId,
           Data item,
           long timeout)

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

Parameters:

name - Name of the Transcational Queue

txnId - ID of the transaction

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

item - The element to add

timeout - How long to wait before giving up, in milliseconds

Returns:

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

take

Object take(String name,
          String txnId,
          long threadId)

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

Parameters:

name - Name of the Transactional Queue

txnId - ID of the transaction

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

The head of this queue

poll

Object poll(String name,
          String txnId,
          long threadId,
          long timeout)

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

Parameters:

name - Name of the Transactional Queue

txnId - ID of the transaction

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

timeout - How long to wait before giving up, in milliseconds

Returns:

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

peek

Object peek(String name,
          String txnId,
          long threadId,
          long timeout)

Retrieves, but does not remove, the head of this queue, or returns null if this queue is empty.

Parameters:

name - Name of the Transactional Queue

txnId - ID of the transaction

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

timeout - How long to wait before giving up, in milliseconds

Returns:

The value at the head of the queue.

size

Object size(String name,
          String txnId,
          long threadId)

Returns the number of elements in this collection.If this collection contains more than Integer.MAX_VALUE elements, returns Integer.MAX_VALUE.

Parameters:

name - Name of the Transactional Queue

txnId - ID of the transaction

threadId - The id of the user thread performing the operation. It is used to guarantee that only the lock holder thread (if a lock exists on the entry) can perform the requested operation.

Returns:

The number of elements in this collection