com.mopub.volley

Class RequestQueue

java.lang.Object

com.mopub.volley.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.RequestEvent Request event types the listeners RequestQueue.RequestEventListener will be notified about.
static interface	RequestQueue.RequestEventListener Callback interface for request life cycle events.
static interface	RequestQueue.RequestFilter A simple predicate or filter interface for Requests, for use by cancelAll(RequestFilter).
static interface	RequestQueue.RequestFinishedListener<T> Deprecated.

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

Modifier and Type	Method and Description
<T> Request<T>	add(Request<T> request) Adds a Request to the dispatch queue.
void	addRequestEventListener(RequestQueue.RequestEventListener listener) Add a listener for request life cycle events.
<T> void	addRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener) Deprecated.
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	getSequenceNumber() Gets a sequence number.
void	removeRequestEventListener(RequestQueue.RequestEventListener listener) Remove a listener for request life cycle events.
<T> void	removeRequestFinishedListener(RequestQueue.RequestFinishedListener<T> listener) Deprecated.
void	start() Starts the dispatchers in this queue.
void	stop() Stops the cache and network dispatchers.

Methods inherited from class java.lang.Object

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

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

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

addRequestEventListener

public void addRequestEventListener(RequestQueue.RequestEventListener listener)

Add a listener for request life cycle events.

removeRequestEventListener

public void removeRequestEventListener(RequestQueue.RequestEventListener listener)

Remove a listener for request life cycle events.

addRequestFinishedListener

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

Deprecated.

removeRequestFinishedListener

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

Deprecated.

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