com.hazelcast.cp.internal.datastructures.countdownlatch.proxy

Class RaftCountDownLatchProxy

java.lang.Object

com.hazelcast.cp.internal.datastructures.countdownlatch.proxy.RaftCountDownLatchProxy

All Implemented Interfaces:

DistributedObject, ICountDownLatch

public class RaftCountDownLatchProxy
extends Object
implements ICountDownLatch

Server-side Raft-based proxy implementation of ICountDownLatch

Constructor Summary

Constructors

Constructor and Description
RaftCountDownLatchProxy(NodeEngine nodeEngine, RaftGroupId groupId, String proxyName, String objectName)

Method Summary

Modifier and Type	Method and Description
boolean	await(long timeout, TimeUnit unit) 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() Decrements the count of the latch, releasing all waiting threads if the count reaches zero.
void	destroy() Destroys this object cluster-wide.
int	getCount() Returns the current count.
CPGroupId	getGroupId()
String	getName() Returns the unique name for this DistributedObject.
String	getPartitionKey() Returns the key of the partition that this DistributedObject is assigned to.
String	getServiceName() Returns the service name for this object.
boolean	trySetCount(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

RaftCountDownLatchProxy

public RaftCountDownLatchProxy(NodeEngine nodeEngine,
                               RaftGroupId groupId,
                               String proxyName,
                               String objectName)

Method Detail

await

public boolean await(long timeout,
                     TimeUnit unit)

Description copied from interface: ICountDownLatch

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 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 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, false if the waiting time elapsed before the count reached zero

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()

Description copied from interface: ICountDownLatch

Returns the current count.

Specified by:

getCount in interface ICountDownLatch

Returns:

the current count

trySetCount

public boolean trySetCount(int count)

Description copied from interface: ICountDownLatch

Sets the count to the given value if the current count is zero.

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

Specified by:

trySetCount in interface ICountDownLatch

Parameters:

count - the number of times ICountDownLatch.countDown() must be invoked before threads can pass through ICountDownLatch.await(long, java.util.concurrent.TimeUnit)

Returns:

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

getPartitionKey

public String getPartitionKey()

Description copied from interface: DistributedObject

Returns the key of the partition that this DistributedObject is assigned to. The returned value only has meaning for a non-partitioned data structure like an IAtomicLong. For a partitioned data structure like an IMap, the returned value will not be null, but otherwise undefined.

Specified by:

getPartitionKey in interface DistributedObject

Returns:

the partition key.

getName

public String getName()

Description copied from interface: DistributedObject

Returns the unique name for this DistributedObject. The returned value will never be null. The suggested way for getting name is retrieving it through DistributedObjectUtil.getName(DistributedObject) because this might be also a PrefixedDistributedObject.

Specified by:

getName in interface DistributedObject

Returns:

the unique name for this object.

getServiceName

public String getServiceName()

Description copied from interface: DistributedObject

Returns the service name for this object.

Specified by:

getServiceName in interface DistributedObject

Returns:

the service name for this object.

destroy

public void destroy()

Description copied from interface: DistributedObject

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

Specified by:

destroy in interface DistributedObject

getGroupId

public CPGroupId getGroupId()