org.apache.cassandra.utils.concurrent.Promise Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cassandra-all Show documentation
The Apache Cassandra Project develops a highly scalable second-generation distributed database, bringing together Dynamo's fully distributed design and Bigtable's ColumnFamily-based data model.
There is a newer version: 5.0.0
Show newest version
/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.apache.cassandra.utils.concurrent;

import java.util.concurrent.Executor;
import java.util.concurrent.ExecutorService;
import java.util.function.Consumer;

import com.google.common.util.concurrent.FutureCallback;

import io.netty.util.concurrent.GenericFutureListener;
import org.apache.cassandra.utils.Shared;

import static org.apache.cassandra.utils.Shared.Recursive.INTERFACES;
import static org.apache.cassandra.utils.Shared.Scope.SIMULATION;

/**
 * A Promise that integrates {@link io.netty.util.concurrent.Promise} with our {@link Future} API
 * to improve clarity and coherence in the codebase.
 */
@Shared(scope = SIMULATION, ancestors = INTERFACES)
public interface Promise extends io.netty.util.concurrent.Promise, Future
{
    public static  GenericFutureListener> listener(FutureCallback callback)
    {
        return future -> {
            if (future.isSuccess()) callback.onSuccess(future.getNow());
            else callback.onFailure(future.cause());
        };
    }

    public static  GenericFutureListener> listener(ExecutorService executor, FutureCallback callback)
    {
        return future -> executor.execute(() -> {
            if (future.isSuccess()) callback.onSuccess(future.getNow());
            else callback.onFailure(future.cause());
        });
    }

    @Override
    Promise addCallback(FutureCallback callback);

    Promise addCallback(FutureCallback callback, Executor executor);

    Promise addCallback(Consumer onSuccess, Consumer onFailure);

    @Override
    Promise addListener(GenericFutureListener> var1);

    @Override
    Promise addListeners(GenericFutureListener>... var1);

    @Override
    Promise removeListener(GenericFutureListener> var1);

    @Override
    Promise removeListeners(GenericFutureListener>... var1);

    /**
     * Complete the promise successfully if not already complete
     * @throws IllegalStateException if already set
     */
    @Override
    Promise setSuccess(V v) throws IllegalStateException;

    /**
     * Complete the promise abnormally if not already complete
     * @throws IllegalStateException if already set
     */
    @Override
    Promise setFailure(Throwable throwable) throws IllegalStateException;

    /**
     * Prevent a future caller from cancelling this promise
     * @return true iff this invocation set it to uncancellable, whether or not now uncancellable
     */
    boolean setUncancellableExclusive();

    /**
     * Wait indefinitely for this promise to complete, throwing any interrupt
     * @throws InterruptedException if interrupted
     */
    @Override
    Promise await() throws InterruptedException;

    /**
     * Wait indefinitely for this promise to complete
     */
    @Override
    Promise awaitUninterruptibly();

    /**
     * Wait indefinitely for this promise to complete, throwing any interrupt as an UncheckedInterruptedException
     * @throws UncheckedInterruptedException if interrupted
     */
    @Override
    Promise awaitThrowUncheckedOnInterrupt();

    /**
     * waits for completion; in case of failure rethrows the original exception without a new wrapping exception
     * so may cause problems for reporting stack traces
     */
    @Override
    Promise sync() throws InterruptedException;

    /**
     * waits for completion; in case of failure rethrows the original exception without a new wrapping exception
     * so may cause problems for reporting stack traces
     */
    @Override
    Promise syncUninterruptibly();
}