com.hazelcast.client

Class CountDownLatchClientProxy

java.lang.Object

com.hazelcast.client.CountDownLatchClientProxy

All Implemented Interfaces:

ICountDownLatch, Instance

public class CountDownLatchClientProxy
extends Object
implements ICountDownLatch

Nested Class Summary

Nested classes/interfaces inherited from interface com.hazelcast.core.Instance

Instance.InstanceType

Constructor Summary

Constructors

Constructor and Description
CountDownLatchClientProxy(HazelcastClient hazelcastClient, String name)

Method Summary

Methods

Modifier and Type	Method and Description
void	await() Causes the current thread to wait until the latch has counted down to zero or an exception is thrown.
boolean	await(long timeout, TimeUnit unit) Causes the current thread to wait until the latch has counted down to zero, an exception is thrown, or the specified waiting time elapses.
void	countDown() Decrements the count of the latch, releasing all waiting threads if the count reaches zero.
void	destroy() Destroys this instance cluster-wide.
int	getCount()
Object	getId() Returns the unique id for this instance.
Instance.InstanceType	getInstanceType() Returns instance type such as map, set, list, lock, topic, multimap, id generator
LocalCountDownLatchStats	getLocalCountDownLatchStats()
String	getName() Returns the name of this ICountDownLatch instance.
Member	getOwner()
boolean	hasCount() Returns whether the current count is greater than zero.
boolean	setCount(int count) Sets the count to the given value if the current count is zero.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CountDownLatchClientProxy

public CountDownLatchClientProxy(HazelcastClient hazelcastClient,
                         String name)

Method Detail

await

public void await()
           throws InstanceDestroyedException,
                  MemberLeftException,
                  InterruptedException

Description copied from interface: ICountDownLatch

Causes the current thread to wait until the latch has counted down to zero or an exception is thrown.

If the current count is zero then this method returns immediately.

If the current count is greater than zero then the current thread becomes disabled for thread scheduling purposes and lies dormant until one of four things happen:

• The count reaches zero due to invocations of the ICountDownLatch.countDown() method;
• This ICountDownLatch instance is destroyed;
• The countdown owner becomes disconnected; or
• Some other thread interrupts the current thread.

If the ICountDownLatch instance is destroyed while waiting then InstanceDestroyedException will be thrown.

If the countdown owner becomes disconnected while waiting then MemberLeftException will be thrown.

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.

Specified by:

await in interface ICountDownLatch

Throws:

InstanceDestroyedException - if the instance is destroyed while waiting

MemberLeftException - if the countdown owner becomes disconnected while waiting

InterruptedException - if the current thread is interrupted

await

public boolean await(long timeout,
            TimeUnit unit)
              throws InstanceDestroyedException,
                     MemberLeftException,
                     InterruptedException

Description copied from interface: ICountDownLatch

Causes the current thread to wait until the latch has counted down to zero, 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 ICountDownLatch.countDown() method;
• This ICountDownLatch instance is destroyed;
• The countdown owner becomes disconnected;
• Some other thread 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 ICountDownLatch instance is destroyed while waiting then InstanceDestroyedException will be thrown.

If the countdown owner becomes disconnected while waiting then MemberLeftException will be thrown.

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.

Specified by:

await in interface ICountDownLatch

Parameters:

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

true if the count reached zero and false if the waiting time elapsed before the count reached zero

Throws:

InstanceDestroyedException - if the instance is destroyed while waiting

MemberLeftException - if the countdown owner becomes disconnected while waiting

InterruptedException - if the current thread is interrupted

countDown

public void countDown()

Description copied from interface: ICountDownLatch

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.

Specified by:

countDown in interface ICountDownLatch

getCount

public int getCount()

getOwner

public Member getOwner()

hasCount

public boolean hasCount()

Description copied from interface: ICountDownLatch

Returns whether the current count is greater than zero.

Specified by:

hasCount in interface ICountDownLatch

Returns:

true if count is greater than zero

setCount

public boolean setCount(int count)

Description copied from interface: ICountDownLatch

Sets the count to the given value if the current count is zero. The calling cluster member becomes the owner of the countdown and is responsible for staying connected to the cluster until the count reaches zero.

If the owner becomes disconnected before the count reaches zero:

• Count will be set to zero;
• Countdown owner will be set to null; and
• All awaiting threads will be thrown a MemberLeftException.

If count is not zero then this method does nothing and returns false.

Specified by:

setCount in interface ICountDownLatch

Parameters:

count - the number of times ICountDownLatch.countDown() must be invoked before threads can pass through ICountDownLatch.await()

Returns:

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

destroy

public void destroy()

Description copied from interface: Instance

Destroys this instance cluster-wide. Clears and releases all resources for this instance.

Specified by:

destroy in interface Instance

getId

public Object getId()

Description copied from interface: Instance

Returns the unique id for this instance.

Specified by:

getId in interface Instance

Returns:

id the of this instance

getInstanceType

public Instance.InstanceType getInstanceType()

Description copied from interface: Instance

Returns instance type such as map, set, list, lock, topic, multimap, id generator

Specified by:

getInstanceType in interface Instance

Returns:

instance type

getName

public String getName()

Description copied from interface: ICountDownLatch

Returns the name of this ICountDownLatch instance.

Specified by:

getName in interface ICountDownLatch

Returns:

name of this instance

getLocalCountDownLatchStats

public LocalCountDownLatchStats getLocalCountDownLatchStats()

Specified by:

getLocalCountDownLatchStats in interface ICountDownLatch