/*
* Copyright 2010 Ning, Inc.
*
* Ning 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.
*/
/*
* Copyright (C) 2007 Google 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.ning.http.client;
import java.util.concurrent.Callable;
import java.util.concurrent.Executor;
import java.util.concurrent.Future;
/**
* Extended {@link Future}
*
* @param <V> Type of the value that will be returned.
*/
public interface ListenableFuture<V> extends Future<V> {
/**
* Execute a {@link Callable} and if there is no exception, mark this Future as done and release the internal lock.
*
* @param callable
*/
void done(Callable callable);
/**
* Abort the current processing, and propagate the {@link Throwable} to the {@link AsyncHandler} or {@link Future}
*
* @param t
*/
void abort(Throwable t);
/**
* Set the content that will be returned by this instance
*
* @param v the content that will be returned by this instance
*/
void content(V v);
/**
* Touch the current instance to prevent external service to times out.
*/
void touch();
/**
* Write the {@link Request} headers
*/
boolean getAndSetWriteHeaders(boolean writeHeader);
/**
* Write the {@link Request} body
*/
boolean getAndSetWriteBody(boolean writeBody);
/**
* <p>Adds a listener and executor to the ListenableFuture.
* The listener will be {@linkplain java.util.concurrent.Executor#execute(Runnable) passed
* to the executor} for execution when the {@code Future}'s computation is
* {@linkplain Future#isDone() complete}.
* <p/>
* <p>There is no guaranteed ordering of execution of listeners, they may get
* called in the order they were added and they may get called out of order,
* but any listener added through this method is guaranteed to be called once
* the computation is complete.
*
* @param listener the listener to run when the computation is complete.
* @param exec the executor to run the listener in.
* @return this Future
* @throws NullPointerException if the executor or listener was null.
* @throws java.util.concurrent.RejectedExecutionException
* if we tried to execute the listener
* immediately but the executor rejected it.
*/
ListenableFuture<V> addListener(Runnable listener, Executor exec);
}