com.almende.util.callback.AsyncCallbackQueue Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of eve-bundle-android-ws Show documentation
There is a newer version: 3.1.1
Show newest version
/*
 * Copyright: Almende B.V. (2014), Rotterdam, The Netherlands
 * License: The Apache Software License, Version 2.0
 */
package com.almende.util.callback;

import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.ScheduledThreadPoolExecutor;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;

import com.almende.util.threads.ThreadPool;

/**
 * Queue to hold a list with callbacks in progress.
 * The Queue handles timeouts on the callbacks.
 * 
 * @param 
 *            the generic type
 */
public class AsyncCallbackQueue {
	private final Map	queue		= new ConcurrentHashMap(5);
	// FIXME: provide some means for the Appengine implementation of
	// ThreadManager.
	private static ScheduledThreadPoolExecutor	scheduler	= ThreadPool.getScheduledPool();
	
	/** timeout in seconds */
	private int									defTimeout	= 30;
	
	/**
	 * Append a callback to the queue.
	 * 
	 * The callback must be pulled from the queue again within the
	 * timeout. If not, the callback.onFailure will be called with a
	 * TimeoutException as argument, and is deleted from the queue.
	 * 
	 * The method will throw an exception when a callback with the same id
	 * is already in the queue.
	 * 
	 * @param id
	 *            the id
	 * @param description
	 *            the description
	 * @param callback
	 *            the callback
	 */
	public void push(final Object id, final String description,
			final AsyncCallback callback) {
		if (queue.containsKey(id)) {
			throw new IllegalStateException("Callback with id '" + id
					+ "' already in queue");
		}
		
		final AsyncCallbackQueue me = this;
		final CallbackHandler handler = new CallbackHandler();
		handler.callback = callback;
		handler.timeout = scheduler.schedule(new Runnable() {
			@Override
			public void run() {
				final AsyncCallback callback = me.pull(id);
				if (callback != null) {
					callback.onFailure(new TimeoutException(
							"Timeout occurred for request with id '" + id
									+ "': " + description));
				}
			}
		}, defTimeout, TimeUnit.SECONDS);
		queue.put(id, handler);
	}
	
	/**
	 * Pull a callback from the queue. The callback can be pulled from the
	 * queue only once. If no callback is found with given id, null will
	 * be returned.
	 * 
	 * @param id
	 *            the id
	 * @return the async callback
	 */
	public AsyncCallback pull(final Object id) {
		final CallbackHandler handler = queue.remove(id);
		if (handler != null) {
			// stop the timeout
			handler.timeout.cancel(true);
			handler.timeout = null;
			return handler.callback;
		}
		return null;
	}
	
	/**
	 * Remove all callbacks from the queue.
	 */
	public synchronized void clear() {
		queue.clear();
	}
	
	/**
	 * Helper class to store a callback and its timeout task.
	 */
	private class CallbackHandler {
		private AsyncCallback	callback;
		private ScheduledFuture	timeout;
	}
	
	/**
	 * Gets the default callback timeout.
	 * 
	 * @return the default timeout
	 */
	public int getDefTimeout() {
		return defTimeout;
	}
	
	/**
	 * Sets the default callback timeout.
	 * 
	 * @param defTimeout
	 *            the new default timeout
	 */
	public void setDefTimeout(int defTimeout) {
		this.defTimeout = defTimeout;
	}
	
}