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

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

Redis based In-Memory Data Grid for Java

There is a newer version: 3.36.0

/**
 * Copyright (c) 2013-2021 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;

/**
 * RingBuffer based queue evicts elements from the head if queue capacity became full.
 * 
 * The head element removed if new element added and queue is full. 
 * 
 * Must be initialized with capacity size {@link #trySetCapacity(int)} before usage.
 * 
 * @author Nikita Koksharov
 *
 * @param  value type
 */
public interface RRingBufferRx extends RQueueRx {

    /**
     * Sets queue capacity only if it is not set before.
     *
     * @param capacity - queue capacity
     * @return true if capacity set successfully
     *         false if capacity already set
     */
    Single trySetCapacity(int capacity);

    /**
     * Sets capacity of the queue and overrides current value.
     * Trims queue if previous capacity value was greater than new.
     *
     * @param capacity - queue capacity
     */
    Completable setCapacity(int capacity);

    /**
     * Returns remaining capacity of this queue
     * 
     * @return remaining capacity
     */
    Single remainingCapacity();
    
    /**
     * Returns capacity of this queue
     * 
     * @return queue capacity
     */
    Single capacity();
    
}