org.redisson.api

Interface RCountDownLatchRx

All Superinterfaces:

RObjectRx

public interface RCountDownLatchRx
extends RObjectRx

RxJava2 interface of Redis based CountDownLatch It has an advantage over CountDownLatch -- count can be set via trySetCount(long) method.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	await() Waits until counter reach zero.
io.reactivex.Single<Boolean>	await(long waitTime, TimeUnit unit) Waits until counter reach zero or up to defined timeout.
io.reactivex.Completable	countDown() Decrements the counter of the latch.
io.reactivex.Single<Long>	getCount() Returns value of current count.
io.reactivex.Single<Boolean>	trySetCount(long count) Sets new count value only if previous count already has reached zero or is not set at all.

Methods inherited from interface org.redisson.api.RObjectRx

addListener, copy, delete, dump, getCodec, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Method Detail

await

io.reactivex.Completable await()

Waits until counter reach zero.

Returns:

void

await

io.reactivex.Single<Boolean> await(long waitTime,
                                   TimeUnit unit)

Waits until counter reach zero or up to defined timeout.

Parameters:

waitTime - the maximum time to wait

unit - the time unit

Returns:

true if the count reached zero and false if timeout reached before the count reached zero

countDown

io.reactivex.Completable countDown()

Decrements the counter of the latch. Notifies all waiting threads when count reaches zero.

Returns:

void

getCount

io.reactivex.Single<Long> getCount()

Returns value of current count.

Returns:

the current count

trySetCount

io.reactivex.Single<Boolean> trySetCount(long count)

Sets new count value only if previous count already has reached zero or is not set at all.

Parameters:

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

Returns:

true if new count setted false if previous count has not reached zero