com.hazelcast.client.impl.protocol.template

Interface CPCountDownLatchCodecTemplate

@Since(value="1.8")
public interface CPCountDownLatchCodecTemplate

Method Summary

Modifier and Type	Method and Description
Object	await(RaftGroupId groupId, String name, UUID invocationUid, long timeoutMs) Causes the current thread to wait until the latch has counted down to zero, or an exception is thrown, or the specified waiting time elapses.
void	countDown(RaftGroupId groupId, String name, UUID invocationUid, int expectedRound) Decrements the count of the latch, releasing all waiting threads if the count reaches zero.
Object	getCount(RaftGroupId groupId, String name) Returns the current count.
Object	getRound(RaftGroupId groupId, String name) Returns the current round.
Object	trySetCount(RaftGroupId groupId, String name, int count) Sets the count to the given value if the current count is zero.

Method Detail

trySetCount

Object trySetCount(RaftGroupId groupId,
                   String name,
                   int count)

Sets the count to the given value if the current count is zero. If the count is not zero, then this method does nothing and returns false

Parameters:

groupId - CP group id of this CountDownLatch instance

name - Name of the CountDownLatch instance

count - The number of times countDown must be invoked before threads can pass through await

Returns:

true if the new count was set, false if the current count is not zero.

await

Object await(RaftGroupId groupId,
             String name,
             UUID invocationUid,
             long timeoutMs)

Causes the current thread to wait until the latch has counted down to zero, or an exception is thrown, or the specified waiting time elapses. If the current count is zero then this method returns immediately with the value true. If the current count is greater than zero, then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of five things happen: the count reaches zero due to invocations of the countDown method, this ICountDownLatch instance is destroyed, the countdown owner becomes disconnected, some other thread Thread#interrupt interrupts the current thread, or the specified waiting time elapses. If the count reaches zero then the method returns with the value true. If the current thread has its interrupted status set on entry to this method, or is interrupted while waiting, then InterruptedException is thrown and the current thread's interrupted status is cleared. If the specified waiting time elapses then the value false is returned. If the time is less than or equal to zero, the method will not wait at all.

Parameters:

groupId - CP group id of this CountDownLatch instance

name - Name of this CountDownLatch instance

invocationUid - UID of this invocation

timeoutMs - The maximum time in milliseconds to wait

Returns:

true if the count reached zero, false if the waiting time elapsed before the count reached 0

countDown

void countDown(RaftGroupId groupId,
               String name,
               UUID invocationUid,
               int expectedRound)

Decrements the count of the latch, releasing all waiting threads if the count reaches zero. If the current count is greater than zero, then it is decremented. If the new count is zero: All waiting threads are re-enabled for thread scheduling purposes, and Countdown owner is set to null. If the current count equals zero, then nothing happens.

Parameters:

groupId - CP group id of this CountDownLatch instance

name - Name of the CountDownLatch instance

invocationUid - UID of this invocation

expectedRound - The round this invocation will be performed on

getCount

Object getCount(RaftGroupId groupId,
                String name)

Returns the current count.

Parameters:

groupId - CP group id of this CountDownLatch instance

name - Name of the CountDownLatch instance

Returns:

The current count of this CountDownLatch instance

getRound

Object getRound(RaftGroupId groupId,
                String name)

Returns the current round. A round completes when the count value reaches to 0 and a new round starts afterwards.

Parameters:

groupId - CP group id of this CountDownLatch instance

name - Name of the CountDownLatch instance

Returns:

The current round of this CountDownLatch instance