org.redisson.api.RCountDownLatchRx Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of redisson Show documentation

Redis Java client with features of In-Memory Data Grid

There is a newer version: 3.40.2

/**
 * Copyright (c) 2013-2024 Nikita Koksharov
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.api;

import io.reactivex.rxjava3.core.Completable;
import io.reactivex.rxjava3.core.Single;

import java.util.concurrent.TimeUnit;

/**
 * RxJava2 interface of Redis based {@link java.util.concurrent.CountDownLatch}
 *
 * It has an advantage over {@link java.util.concurrent.CountDownLatch} --
 * count can be set via {@link #trySetCount} method.
 *
 * @author Nikita Koksharov
 *
 */
public interface RCountDownLatchRx extends RObjectRx {

    /**
     * Waits until counter reach zero.
     *
     * @return void
     *
     */
    Completable await();

    /**
     * Waits until counter reach zero or up to defined timeout.
     *
     * @param waitTime the maximum time to wait
     * @param unit the time unit
     * @return true if the count reached zero and false
     *         if timeout reached before the count reached zero
     */
    Single await(long waitTime, TimeUnit unit);

    /**
     * Decrements the counter of the latch.
     * Notifies all waiting threads when count reaches zero.
     * 
     * @return void
     */
    Completable countDown();

    /**
     * Returns value of current count.
     *
     * @return the current count
     */
    Single getCount();

    /**
     * Sets new count value only if previous count already has reached zero
     * or is not set at all.
     *
     * @param count - number of times countDown must be invoked
     *        before threads can pass through await
     * @return true if new count setted
     *         false if previous count has not reached zero
     */
    Single trySetCount(long count);

}