com.datastax.driver.core.CloseFuture Maven / Gradle / Ivy

/*
 * Copyright DataStax, Inc.
 *
 * 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 com.datastax.driver.core;

import com.google.common.util.concurrent.AbstractFuture;
import com.google.common.util.concurrent.FutureCallback;
import com.google.common.util.concurrent.Futures;
import java.util.List;

/**
 * A future on the shutdown of a Cluster or Session instance.
 *
 * This is a standard future except for the fact that this class has an additional {@link #force}
 * method that can be used to expedite the shutdown process (see below).
 *
 * 
Note that this class implements Guava's {@code
 * ListenableFuture} and can so be used with Guava's future utilities.
 */
public abstract class CloseFuture extends AbstractFuture {

  CloseFuture() {}

  static CloseFuture immediateFuture() {
    CloseFuture future =
        new CloseFuture() {
          @Override
          public CloseFuture force() {
            return this;
          }
        };
    future.set(null);
    return future;
  }

  /**
   * Try to force the completion of the shutdown this is a future of.
   *
   * 
This method will do its best to expedite the shutdown process. In particular, all
   * connections will be closed right away, even if there are ongoing queries at the time this
   * method is called.
   *
   * Note that this method does not block. The completion of this method does not imply the
   * shutdown process is done, you still need to wait on this future to ensure that, but calling
   * this method will ensure said future will return in a timely way.
   *
   * @return this {@code CloseFuture}.
   */
  public abstract CloseFuture force();

  // Internal utility for cases where we want to build a future that wait on other ones
  static class Forwarding extends CloseFuture {

    private final List futures;

    Forwarding(List futures) {
      this.futures = futures;

      GuavaCompatibility.INSTANCE.addCallback(
          Futures.allAsList(futures),
          new FutureCallback>() {
            @Override
            public void onFailure(Throwable t) {
              Forwarding.this.setException(t);
            }

            @Override
            public void onSuccess(List v) {
              Forwarding.this.onFuturesDone();
            }
          });
    }

    @Override
    public CloseFuture force() {
      for (CloseFuture future : futures) future.force();
      return this;
    }

    protected void onFuturesDone() {
      set(null);
    }
  }
}