1d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru/* 2d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Copyright (C) 2011 The Android Open Source Project 3d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 4d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Licensed under the Apache License, Version 2.0 (the "License"); 5d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * you may not use this file except in compliance with the License. 6d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * You may obtain a copy of the License at 7d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 8d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * http://www.apache.org/licenses/LICENSE-2.0 9d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 10d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Unless required by applicable law or agreed to in writing, software 11d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * distributed under the License is distributed on an "AS IS" BASIS, 12d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * See the License for the specific language governing permissions and 14d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * limitations under the License. 15d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 16d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 17d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Querupackage com.android.volley; 18d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 19d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport android.os.Handler; 20d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport android.os.Looper; 21d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 22d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.HashMap; 23d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.HashSet; 24d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.LinkedList; 25d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.Map; 26d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.Queue; 27d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.Set; 28d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.concurrent.PriorityBlockingQueue; 29d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queruimport java.util.concurrent.atomic.AtomicInteger; 30d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 31d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru/** 32d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * A request dispatch queue with a thread pool of dispatchers. 33d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 34d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Calling {@link #add(Request)} will enqueue the given Request for dispatch, 35d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * resolving from either cache or network on a worker thread, and then delivering 36d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * a parsed response on the main thread. 37d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 38d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru@SuppressWarnings("rawtypes") 39d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Querupublic class RequestQueue { 40d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 41d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Used for generating monotonically-increasing sequence numbers for requests. */ 426772bce3d3322ccbcf6481545ffe895d5d401b39Jean-Baptiste Queru private AtomicInteger mSequenceGenerator = new AtomicInteger(); 43d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 44d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 45d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Staging area for requests that already have a duplicate request in flight. 46d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 47d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * <ul> 48d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * <li>containsKey(cacheKey) indicates that there is a request in flight for the given cache 49d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * key.</li> 50d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * <li>get(cacheKey) returns waiting requests for the given cache key. The in flight request 51d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * is <em>not</em> contained in that list. Is null if no requests are staged.</li> 52d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * </ul> 53d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 54d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final Map<String, Queue<Request>> mWaitingRequests = 55d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru new HashMap<String, Queue<Request>>(); 56d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 57d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 58d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * The set of all requests currently being processed by this RequestQueue. A Request 59d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * will be in this set if it is waiting in any queue or currently being processed by 60d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * any dispatcher. 61d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 62d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final Set<Request> mCurrentRequests = new HashSet<Request>(); 63d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 64d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** The cache triage queue. */ 65d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final PriorityBlockingQueue<Request> mCacheQueue = 66d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru new PriorityBlockingQueue<Request>(); 67d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 68d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** The queue of requests that are actually going out to the network. */ 69d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final PriorityBlockingQueue<Request> mNetworkQueue = 70d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru new PriorityBlockingQueue<Request>(); 71d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 72d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Number of network request dispatcher threads to start. */ 73d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private static final int DEFAULT_NETWORK_THREAD_POOL_SIZE = 4; 74d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 75d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Cache interface for retrieving and storing respones. */ 76d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final Cache mCache; 77d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 78d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Network interface for performing requests. */ 79d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final Network mNetwork; 80d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 81d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** Response delivery mechanism. */ 82d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private final ResponseDelivery mDelivery; 83d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 84d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** The network dispatchers. */ 85d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private NetworkDispatcher[] mDispatchers; 86d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 87d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** The cache dispatcher. */ 88d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru private CacheDispatcher mCacheDispatcher; 89d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 90d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 91d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Creates the worker pool. Processing will not begin until {@link #start()} is called. 92d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 93d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param cache A Cache to use for persisting responses to disk 94d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param network A Network interface for performing HTTP requests 95d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param threadPoolSize Number of network dispatcher threads to create 96d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param delivery A ResponseDelivery interface for posting responses and errors 97d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 98d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public RequestQueue(Cache cache, Network network, int threadPoolSize, 99d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru ResponseDelivery delivery) { 100d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCache = cache; 101d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mNetwork = network; 102d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mDispatchers = new NetworkDispatcher[threadPoolSize]; 103d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mDelivery = delivery; 104d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 105d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 106d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 107d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Creates the worker pool. Processing will not begin until {@link #start()} is called. 108d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 109d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param cache A Cache to use for persisting responses to disk 110d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param network A Network interface for performing HTTP requests 111d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param threadPoolSize Number of network dispatcher threads to create 112d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 113d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public RequestQueue(Cache cache, Network network, int threadPoolSize) { 114d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru this(cache, network, threadPoolSize, 115d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru new ExecutorDelivery(new Handler(Looper.getMainLooper()))); 116d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 117d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 118d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 119d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Creates the worker pool. Processing will not begin until {@link #start()} is called. 120d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 121d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param cache A Cache to use for persisting responses to disk 122d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param network A Network interface for performing HTTP requests 123d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 124d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public RequestQueue(Cache cache, Network network) { 125d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru this(cache, network, DEFAULT_NETWORK_THREAD_POOL_SIZE); 126d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 127d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 128d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 129d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Starts the dispatchers in this queue. 130d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 131d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public void start() { 132d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru stop(); // Make sure any currently running dispatchers are stopped. 133d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Create the cache dispatcher and start it. 134d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCacheDispatcher = new CacheDispatcher(mCacheQueue, mNetworkQueue, mCache, mDelivery); 135d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCacheDispatcher.start(); 136d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 137d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Create network dispatchers (and corresponding threads) up to the pool size. 138d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru for (int i = 0; i < mDispatchers.length; i++) { 139d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru NetworkDispatcher networkDispatcher = new NetworkDispatcher(mNetworkQueue, mNetwork, 140d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCache, mDelivery); 141d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mDispatchers[i] = networkDispatcher; 142d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru networkDispatcher.start(); 143d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 144d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 145d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 146d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 147d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Stops the cache and network dispatchers. 148d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 149d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public void stop() { 150d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (mCacheDispatcher != null) { 151d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCacheDispatcher.quit(); 152d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 153d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru for (int i = 0; i < mDispatchers.length; i++) { 154d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (mDispatchers[i] != null) { 155d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mDispatchers[i].quit(); 156d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 157d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 158d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 159d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 160d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 161d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Gets a sequence number. 162d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 1636772bce3d3322ccbcf6481545ffe895d5d401b39Jean-Baptiste Queru public int getSequenceNumber() { 1646772bce3d3322ccbcf6481545ffe895d5d401b39Jean-Baptiste Queru return mSequenceGenerator.incrementAndGet(); 165d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 166d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 167d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 1680acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton * Gets the {@link Cache} instance being used. 1690acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton */ 1700acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton public Cache getCache() { 1710acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton return mCache; 1720acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton } 1730acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton 1740acc7936feb3deb2b969b568b07f3bf96caf0076Evan Charlton /** 175d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * A simple predicate or filter interface for Requests, for use by 176d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * {@link RequestQueue#cancelAll(RequestFilter)}. 177d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 178d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public interface RequestFilter { 179d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public boolean apply(Request<?> request); 180d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 181d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 182d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 183d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Cancels all requests in this queue for which the given filter applies. 184d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param filter The filtering function to use 185d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 186d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public void cancelAll(RequestFilter filter) { 187d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru synchronized (mCurrentRequests) { 188d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru for (Request<?> request : mCurrentRequests) { 189d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (filter.apply(request)) { 190d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru request.cancel(); 191d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 192d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 193d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 194d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 195d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 196d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 197d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Cancels all requests in this queue with the given tag. Tag must be non-null 198d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * and equality is by identity. 199d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 200d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public void cancelAll(final Object tag) { 201d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (tag == null) { 202d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru throw new IllegalArgumentException("Cannot cancelAll with a null tag"); 203d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 204d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru cancelAll(new RequestFilter() { 205d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru @Override 206d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public boolean apply(Request<?> request) { 207d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return request.getTag() == tag; 208d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 209d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru }); 210d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 211d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 212d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 213d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Adds a Request to the dispatch queue. 214d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @param request The request to service 215d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * @return The passed-in request 216d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 217d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru public Request add(Request request) { 218d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Tag the request as belonging to this queue and add it to the set of current requests. 219d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru request.setRequestQueue(this); 220d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru synchronized (mCurrentRequests) { 221d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCurrentRequests.add(request); 222d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 223d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 224d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Process requests in the order they are added. 2256772bce3d3322ccbcf6481545ffe895d5d401b39Jean-Baptiste Queru request.setSequence(getSequenceNumber()); 226d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru request.addMarker("add-to-queue"); 227d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 228d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // If the request is uncacheable, skip the cache queue and go straight to the network. 229d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (!request.shouldCache()) { 230d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mNetworkQueue.add(request); 231d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return request; 232d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 233d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 234d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Insert request into stage if there's already a request with the same cache key in flight. 235d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru synchronized (mWaitingRequests) { 236d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru String cacheKey = request.getCacheKey(); 237d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (mWaitingRequests.containsKey(cacheKey)) { 238d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // There is already a request in flight. Queue up. 239d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Queue<Request> stagedRequests = mWaitingRequests.get(cacheKey); 240d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (stagedRequests == null) { 241d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru stagedRequests = new LinkedList<Request>(); 242d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 243d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru stagedRequests.add(request); 244d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mWaitingRequests.put(cacheKey, stagedRequests); 245d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (VolleyLog.DEBUG) { 246d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru VolleyLog.v("Request for cacheKey=%s is in flight, putting on hold.", cacheKey); 247d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 248d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } else { 249d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Insert 'null' queue for this cacheKey, indicating there is now a request in 250d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // flight. 251d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mWaitingRequests.put(cacheKey, null); 252d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCacheQueue.add(request); 253d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 254d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru return request; 255d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 256d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 257d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 258d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru /** 259d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * Called from {@link Request#finish(String)}, indicating that processing of the given request 260d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * has finished. 261d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * 262d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * <p>Releases waiting requests for <code>request.getCacheKey()</code> if 263d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru * <code>request.shouldCache()</code>.</p> 264d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru */ 265d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru void finish(Request request) { 266d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Remove from the set of requests currently being processed. 267d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru synchronized (mCurrentRequests) { 268d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCurrentRequests.remove(request); 269d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 270d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru 271d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (request.shouldCache()) { 272d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru synchronized (mWaitingRequests) { 273d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru String cacheKey = request.getCacheKey(); 274d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru Queue<Request> waitingRequests = mWaitingRequests.remove(cacheKey); 275d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (waitingRequests != null) { 276d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru if (VolleyLog.DEBUG) { 277d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru VolleyLog.v("Releasing %d waiting requests for cacheKey=%s.", 278d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru waitingRequests.size(), cacheKey); 279d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 280d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // Process all queued up requests. They won't be considered as in flight, but 281d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru // that's not a problem as the cache has been primed by 'request'. 282d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru mCacheQueue.addAll(waitingRequests); 283d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 284d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 285d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 286d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru } 287d56b88ae161057e848e7410d1b9ce5b0b8c427fcJean-Baptiste Queru} 288