org.redisson.api.RQueueAsync Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Show all versions of redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
The newest version!
/**
* 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.util.List;
/**
* {@link java.util.Queue} backed by Redis
*
* @author Nikita Koksharov
*
* @param the type of elements held in this collection
*/
public interface RQueueAsync extends RCollectionAsync {
/**
* Retrieves the head of this queue in async mode.
*
* @return the head of this queue, or {@code null}
*/
RFuture peekAsync();
/**
* Retrieves and removes the head of this queue in async mode.
*
* @return the head of this queue, or {@code null}
*/
RFuture pollAsync();
/**
* Inserts the specified element into this queue.
*
* @param e the element to add
* @return {@code true} if successful, or {@code false}
* @throws ClassCastException if the class of the specified element
* prevents it from being added to this queue
* @throws NullPointerException if the specified element is null
*/
RFuture offerAsync(V e);
/**
* Retrieves and removes last available tail element of this queue queue and adds it at the head of queueName
.
*
* @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
*/
RFuture pollLastAndOfferFirstToAsync(String queueName);
/**
* Returns all queue elements at once
*
* @return elements
*/
RFuture> readAllAsync();
/**
* Retrieves and removes the head elements of this queue.
* Elements amount limited by limit
param.
*
* @return list of head elements
*/
RFuture> pollAsync(int limit);
/**
* Adds object event listener
*
* @see org.redisson.api.listener.TrackingListener
* @see org.redisson.api.ExpiredObjectListener
* @see org.redisson.api.DeletedObjectListener
* @see org.redisson.api.listener.ListAddListener
* @see org.redisson.api.listener.ListInsertListener
* @see org.redisson.api.listener.ListSetListener
* @see org.redisson.api.listener.ListRemoveListener
* @see org.redisson.api.listener.ListTrimListener
*
* @param listener - object event listener
* @return listener id
*/
RFuture addListenerAsync(ObjectListener listener);
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy