org.djodjo.comm.jus

Class RequestQueue

java.lang.Object

org.djodjo.comm.jus.RequestQueue

public class RequestQueue
extends java.lang.Object

A request dispatch queue with a thread pool of dispatchers. Calling add(Request) will enqueue the given Request for dispatch, resolving from either cache or network on a worker thread, and then delivering a parsed response on the main thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RequestQueue.RequestFilter A simple predicate or filter interface for Requests, for use by cancelAll(RequestFilter).
static interface	RequestQueue.RequestFinishedListener<T> Callback interface for completed requests.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_NETWORK_THREAD_POOL_SIZE Number of network request dispatcher threads to start.
protected Cache	mCache Cache interface for retrieving and storing responses.
protected CacheDispatcher	mCacheDispatcher The cache dispatcher.
protected java.util.concurrent.PriorityBlockingQueue<Request<?>>	mCacheQueue The cache triage queue.
protected ResponseDelivery	mDelivery Response delivery mechanism.
protected NetworkDispatcher[]	mDispatchers The network dispatchers.
protected Network	mNetwork Network interface for performing requests.
protected java.util.concurrent.PriorityBlockingQueue<Request<?>>	mNetworkQueue The queue of requests that are actually going out to the network.

Constructor Summary

Constructors

Constructor and Description
RequestQueue(Cache cache, Network network) Creates the worker pool.
RequestQueue(Cache cache, Network network, int threadPoolSize) Creates the worker pool.
RequestQueue(Cache cache, Network network, int threadPoolSize, ResponseDelivery delivery) Creates the worker pool.

Method Summary

Methods

Modifier and Type	Method and Description
<T> Request<T>	add(Request<T> request) Adds a Request to the dispatch queue.
<T> void	addRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener)
void	cancelAll(java.lang.Object tag) Cancels all requests in this queue with the given tag.
void	cancelAll(RequestQueue.RequestFilter filter) Cancels all requests in this queue for which the given filter applies.
Cache	getCache() Gets the Cache instance being used.
int	getCurrentRequests()
int	getSequenceNumber() Gets a sequence number.
int	getWaitingRequests()
<T> void	removeRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener) Remove a RequestFinishedListener.
void	start() Starts the dispatchers in this queue.
void	stop() Stops the cache and network dispatchers.
RequestQueue	withCacheDspather(CacheDispatcher cacheDspather)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mCacheQueue

protected final java.util.concurrent.PriorityBlockingQueue<Request<?>> mCacheQueue

The cache triage queue.

mNetworkQueue

protected final java.util.concurrent.PriorityBlockingQueue<Request<?>> mNetworkQueue

The queue of requests that are actually going out to the network.

DEFAULT_NETWORK_THREAD_POOL_SIZE

public static final int DEFAULT_NETWORK_THREAD_POOL_SIZE

Number of network request dispatcher threads to start.

See Also:

Constant Field Values

mCache

protected final Cache mCache

Cache interface for retrieving and storing responses.

mNetwork

protected final Network mNetwork

Network interface for performing requests.

mDelivery

protected final ResponseDelivery mDelivery

Response delivery mechanism.

mDispatchers

protected NetworkDispatcher[] mDispatchers

The network dispatchers.

mCacheDispatcher

protected CacheDispatcher mCacheDispatcher

The cache dispatcher.

Constructor Detail

RequestQueue

public RequestQueue(Cache cache,
            Network network,
            int threadPoolSize,
            ResponseDelivery delivery)

Creates the worker pool. Processing will not begin until start() is called.

Parameters:

cache - A Cache to use for persisting responses to disk

network - A Network interface for performing HTTP requests

threadPoolSize - Number of network dispatcher threads to create

delivery - A ResponseDelivery interface for posting responses and errors

RequestQueue

public RequestQueue(Cache cache,
            Network network,
            int threadPoolSize)

Creates the worker pool. Processing will not begin until start() is called.

Parameters:

cache - A Cache to use for persisting responses to disk

network - A Network interface for performing HTTP requests

threadPoolSize - Number of network dispatcher threads to create

RequestQueue

public RequestQueue(Cache cache,
            Network network)

Creates the worker pool. Processing will not begin until start() is called.

Parameters:

cache - A Cache to use for persisting responses to disk

network - A Network interface for performing HTTP requests

Method Detail

withCacheDspather

public RequestQueue withCacheDspather(CacheDispatcher cacheDspather)

start

public void start()

Starts the dispatchers in this queue.

stop

public void stop()

Stops the cache and network dispatchers.

getSequenceNumber

public int getSequenceNumber()

Gets a sequence number.

getCache

public Cache getCache()

Gets the Cache instance being used.

cancelAll

public void cancelAll(RequestQueue.RequestFilter filter)

Cancels all requests in this queue for which the given filter applies.

Parameters:

filter - The filtering function to use

cancelAll

public void cancelAll(java.lang.Object tag)

Cancels all requests in this queue with the given tag. Tag must be non-null and equality is by identity.

add

public <T> Request<T> add(Request<T> request)

Adds a Request to the dispatch queue.

Parameters:

request - The request to service

Returns:

The passed-in request

addRequestFinishedListener

public <T> void addRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener)

removeRequestFinishedListener

public <T> void removeRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener)

Remove a RequestFinishedListener. Has no effect if listener was not previously added.

getCurrentRequests

public int getCurrentRequests()

getWaitingRequests

public int getWaitingRequests()