Package org.redisson.api
Interface RCountDownLatchRx
-
- All Superinterfaces:
RObjectRx
public interface RCountDownLatchRx extends RObjectRx
RxJava2 interface of Redis basedCountDownLatch
It has an advantage overCountDownLatch
-- count can be set viatrySetCount(long)
method.- Author:
- Nikita Koksharov
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description io.reactivex.rxjava3.core.Completable
await()
Waits until counter reach zero.io.reactivex.rxjava3.core.Single<Boolean>
await(long waitTime, TimeUnit unit)
Waits until counter reach zero or up to definedtimeout
.io.reactivex.rxjava3.core.Completable
countDown()
Decrements the counter of the latch.io.reactivex.rxjava3.core.Single<Long>
getCount()
Returns value of current count.io.reactivex.rxjava3.core.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, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
-
-
-
-
Method Detail
-
await
io.reactivex.rxjava3.core.Completable await()
Waits until counter reach zero.- Returns:
- void
-
await
io.reactivex.rxjava3.core.Single<Boolean> await(long waitTime, TimeUnit unit)
Waits until counter reach zero or up to definedtimeout
.- Parameters:
waitTime
- the maximum time to waitunit
- the time unit- Returns:
true
if the count reached zero andfalse
if timeout reached before the count reached zero
-
countDown
io.reactivex.rxjava3.core.Completable countDown()
Decrements the counter of the latch. Notifies all waiting threads when count reaches zero.- Returns:
- void
-
getCount
io.reactivex.rxjava3.core.Single<Long> getCount()
Returns value of current count.- Returns:
- the current count
-
trySetCount
io.reactivex.rxjava3.core.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 timescountDown
must be invoked before threads can pass throughawait
- Returns:
true
if new count settedfalse
if previous count has not reached zero
-
-