org.redisson.api.RBlockingQueue Maven / Gradle / Ivy
Show all versions of redisson-all Show documentation
/**
* 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 java.time.Duration;
import java.util.List;
import java.util.Map;
import java.util.concurrent.BlockingQueue;
import java.util.concurrent.CompletionStage;
import java.util.concurrent.TimeUnit;
import java.util.function.Consumer;
import java.util.function.Function;
/**
* Distributed implementation of {@link BlockingQueue}
*
* @author Nikita Koksharov
* @param the type of elements held in this collection
*/
public interface RBlockingQueue extends BlockingQueue, RQueue, RBlockingQueueAsync {
/**
* Retrieves and removes first available head element of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue itself.
*
* @param queueNames - queue names. Queue name itself is always included
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
* @throws InterruptedException if interrupted while waiting
*/
V pollFromAny(long timeout, TimeUnit unit, String... queueNames) throws InterruptedException;
/**
* Retrieves and removes first available head element of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue itself.
*
* @param queueNames queue names. Queue name itself is always included
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @return the head of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
* @throws InterruptedException if interrupted while waiting
*/
Entry pollFromAnyWithName(Duration timeout, String... queueNames) throws InterruptedException;
/**
* Retrieves and removes first available head elements of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue itself.
*
*
* Requires Redis 7.0.0 and higher.
*
* @param duration how long to wait before giving up
* @param count elements amount
* @param queueNames name of queues
* @return the head elements
*/
Map> pollFirstFromAny(Duration duration, int count, String... queueNames) throws InterruptedException;
/**
* Retrieves and removes first available tail elements of any queue,
* waiting up to the specified wait time if necessary for an element to become available
* in any of defined queues including queue itself.
*
*
* Requires Redis 7.0.0 and higher.
*
* @param duration how long to wait before giving up
* @param count elements amount
* @param queueNames name of queues
* @return the tail elements
*/
Map> pollLastFromAny(Duration duration, int count, String... queueNames) throws InterruptedException;
/**
* Retrieves and removes last available tail element of this queue and adds it at the head of queueName,
* waiting up to the specified wait time if necessary for an element to become available.
*
* @param queueName - names of destination queue
* @param timeout how long to wait before giving up, in units of
* {@code unit}
* @param unit a {@code TimeUnit} determining how to interpret the
* {@code timeout} parameter
* @return the tail of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
* @throws InterruptedException if interrupted while waiting
*/
V pollLastAndOfferFirstTo(String queueName, long timeout, TimeUnit unit) throws InterruptedException;
/**
* Retrieves and removes last available tail element of any queue and adds it at the head of queueName,
* waiting if necessary for an element to become available
* in any of defined queues including queue itself.
*
* @param queueName - names of destination queue
* @return the tail of this queue, or {@code null} if the
* specified waiting time elapses before an element is available
* @throws InterruptedException if interrupted while waiting
*/
V takeLastAndOfferFirstTo(String queueName) throws InterruptedException;
/**
* Use {@link #subscribeOnElements(Function)} instead.
*
* @param consumer - queue elements listener
* @return listenerId - id of listener
*/
@Deprecated
int subscribeOnElements(Consumer consumer);
/**
* Subscribes on elements appeared in this queue.
* Continuously invokes {@link #takeAsync()} method to get a new element.
*
* NOTE: don't call blocking methods in the elements listener
*
* @param consumer - queue elements listener
* @return listenerId - id of listener
*/
int subscribeOnElements(Function> consumer);
/**
* Un-subscribes defined listener.
*
* @param listenerId - id of listener
*/
void unsubscribe(int listenerId);
}