net.spy.memcached.internal.BulkFuture Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of spymemcached Show documentation

A client library for memcached.

There is a newer version: 2.8.4

package net.spy.memcached.internal;

import java.util.concurrent.ExecutionException;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

import net.spy.memcached.ops.OperationStatus;

/**
 * Additional flexibility for asyncGetBulk
 *
 * 
 * This interface is now returned from all asyncGetBulk
 * methods. Unlike {@link #get(long, TimeUnit)},
 * {@link #getSome(long, TimeUnit)} does not throw
 * CheckedOperationTimeoutException, thus allowing retrieval
 * of partial results after timeout occurs. This behavior is
 * especially useful in case of large multi gets.
 * 
 *
 * @author [email protected]
 * @param 
 *
 */
public interface BulkFuture extends Future {

	/**
	 * @return true if timeout was reached, false otherwise
	 */
	public boolean isTimeout();

    /**
     * Wait for the operation to complete and return results
     *
     * If operation could not complete within specified
     * timeout, partial result is returned. Otherwise, the
     * behavior is identical to {@link #get(long, TimeUnit)}
     *
     *
     * @param timeout
     * @param unit
     * @return
     * @throws InterruptedException
     * @throws ExecutionException
     */
	public V getSome(long timeout, TimeUnit unit)
			throws InterruptedException, ExecutionException;

	/**
	 * Gets the status of the operation upon completion.
	 *
	 * @return the operation status.
	 */
	public OperationStatus getStatus();

}