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

/**
 * Copyright 2018 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.concurrent.BlockingDeque;
import java.util.concurrent.TimeUnit;

/**
 * Async interface for {@link BlockingDeque} backed by Redis
 *
 * @author Nikita Koksharov
 * @param  the type of elements held in this collection
 */
public interface RBlockingDequeAsync extends RDequeAsync, RBlockingQueueAsync {

    /**
     * Retrieves and removes first available head element of any queue in async mode,
     * waiting up to the specified wait time if necessary for an element to become available
     * in any of defined queues including queue own.
     *
     * @param queueNames - names of 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 head of this queue, or {@code null} if the
     *         specified waiting time elapses before an element is available
     */
    RFuture pollFirstFromAnyAsync(long timeout, TimeUnit unit, String ... queueNames);

    /**
     * Retrieves and removes first available tail element of any queue in async mode,
     * waiting up to the specified wait time if necessary for an element to become available
     * in any of defined queues including queue own.
     * 
     * @param queueNames - names of 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 head of this queue, or {@code null} if the
     *         specified waiting time elapses before an element is available
     */
    RFuture pollLastFromAnyAsync(long timeout, TimeUnit unit, String ... queueNames);

    RFuture putFirstAsync(V e);

    RFuture putLastAsync(V e);

    RFuture pollLastAsync(long timeout, TimeUnit unit);

    RFuture takeLastAsync();

    RFuture pollFirstAsync(long timeout, TimeUnit unit);

    RFuture takeFirstAsync();
}