com.hazelcast.client.impl.protocol.template

Interface ConditionCodecTemplate

public interface ConditionCodecTemplate

Method Summary

Methods

Modifier and Type	Method and Description
Object	await(String name, long threadId, long timeout, String lockName) Causes the current thread to wait until it is signalled or interrupted, or the specified waiting time elapses.
void	beforeAwait(String name, long threadId, String lockName) Causes the current thread to wait until it is signalled or Thread#interrupt interrupted.
void	signal(String name, long threadId, String lockName) If any threads are waiting on this condition then one is selected for waking up.That thread must then re-acquire the lock before returning from await.
void	signalAll(String name, long threadId, String lockName) If any threads are waiting on this condition then they are all woken up.

Method Detail

await

Object await(String name,
           long threadId,
           long timeout,
           String lockName)

Causes the current thread to wait until it is signalled or interrupted, or the specified waiting time elapses.

Parameters:

name - Name of the Condition

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 - The maximum time to wait

lockName - Name of the lock to wait on.

Returns:

False if the waiting time detectably elapsed before return from the method, else true

beforeAwait

void beforeAwait(String name,
               long threadId,
               String lockName)

Causes the current thread to wait until it is signalled or Thread#interrupt interrupted. The lock associated with this Condition is atomically released and the current thread becomes disabled for thread scheduling purposes and lies dormant until one of four things happens: Some other thread invokes the #signal method for this Condition and the current thread happens to be chosen as the thread to be awakened; or Some other thread invokes the #signalAll method for this Condition; or Some other thread Thread#interrupt interrupts the current thread, and interruption of thread suspension is supported; or A spurious wakeup occurs. In all cases, before this method can return the current thread must re-acquire the lock associated with this condition. When the thread returns it is guaranteed to hold this lock. If the current thread: has its interrupted status set on entry to this method; or is Thread#interrupt interrupted while waiting and interruption of thread suspension is supported, then INTERRUPTED is thrown and the current thread's interrupted status is cleared. It is not specified, in the first case, whether or not the test for interruption occurs before the lock is released. The current thread is assumed to hold the lock associated with this Condition when this method is called. It is up to the implementation to determine if this is the case and if not, how to respond. Typically, an exception will be thrown (such as ILLEGAL_MONITOR_STATE) and the implementation must document that fact. An implementation can favor responding to an interrupt over normal method return in response to a signal. In that case the implementation must ensure that the signal is redirected to another waiting thread, if there is one.

Parameters:

name - Name of the Condition

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.

lockName - Name of the lock to wait on.

signal

void signal(String name,
          long threadId,
          String lockName)

If any threads are waiting on this condition then one is selected for waking up.That thread must then re-acquire the lock before returning from await. An implementation may (and typically does) require that the current thread hold the lock associated with this Condition when this method is called. Implementations must document this precondition and any actions taken if the lock is not held. Typically, an exception such as ILLEGAL_MONITOR_STATE will be thrown.

Parameters:

name - Name of the Condition

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.

lockName - Name of the lock to wait on.

signalAll

void signalAll(String name,
             long threadId,
             String lockName)

If any threads are waiting on this condition then they are all woken up. Each thread must re-acquire the lock before it can return from

Parameters:

name - Name of the Condition

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.

lockName - Name of the lock to wait on.