1069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/* 2069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/impl/conn/tsccm/RefQueueWorker.java $ 3069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Revision: 673450 $ 4069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * $Date: 2008-07-02 10:35:05 -0700 (Wed, 02 Jul 2008) $ 5069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 6069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 7069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 8069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Licensed to the Apache Software Foundation (ASF) under one or more 9069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * contributor license agreements. See the NOTICE file distributed with 10069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this work for additional information regarding copyright ownership. 11069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The ASF licenses this file to You under the Apache License, Version 2.0 12069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * (the "License"); you may not use this file except in compliance with 13069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * the License. You may obtain a copy of the License at 14069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 15069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 16069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 17069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 18069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 19069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 20069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * See the License for the specific language governing permissions and 21069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * limitations under the License. 22069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * ==================================================================== 23069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 24069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This software consists of voluntary contributions made by many 25069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * individuals on behalf of the Apache Software Foundation. For more 26069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * information on the Apache Software Foundation, please see 27069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * <http://www.apache.org/>. 28069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 29069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 30069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 31069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpackage org.apache.http.impl.conn.tsccm; 32069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 33069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.lang.ref.Reference; 34069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport java.lang.ref.ReferenceQueue; 35069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 36069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.logging.Log; 37069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectimport org.apache.commons.logging.LogFactory; 38069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 39069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 40069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 41069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project/** 42069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * A worker thread for processing queued references. 43069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link Reference Reference}s can be 44069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * {@link ReferenceQueue queued} 45069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * automatically by the garbage collector. 46069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If that feature is used, a daemon thread should be executing 47069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * this worker. It will pick up the queued references and pass them 48069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * on to a handler for appropriate processing. 49d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * 50d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * @deprecated Please use {@link java.net.URL#openConnection} instead. 51d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a> 52d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath * for further details. 53069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 54d42abb2fd917184764daf22f5f299e848b8701d7Narayan Kamath@Deprecated 55069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Projectpublic class RefQueueWorker implements Runnable { 56069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 57069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project private final Log log = LogFactory.getLog(getClass()); 58069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 59069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** The reference queue to monitor. */ 60069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected final ReferenceQueue<?> refQueue; 61069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 62069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** The handler for the references found. */ 63069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected final RefQueueHandler refHandler; 64069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 65069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 66069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 67069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The thread executing this handler. 68069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * This attribute is also used as a shutdown indicator. 69069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 70069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project protected volatile Thread workerThread; 71069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 72069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 73069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 74069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Instantiates a new worker to listen for lost connections. 75069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 76069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param queue the queue on which to wait for references 77069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @param handler the handler to pass the references to 78069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 79069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public RefQueueWorker(ReferenceQueue<?> queue, RefQueueHandler handler) { 80069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (queue == null) { 81069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Queue must not be null."); 82069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 83069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (handler == null) { 84069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project throw new IllegalArgumentException("Handler must not be null."); 85069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 86069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 87069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project refQueue = queue; 88069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project refHandler = handler; 89069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 90069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 91069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 92069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 93069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * The main loop of this worker. 94069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * If initialization succeeds, this method will only return 95069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * after {@link #shutdown shutdown()}. Only one thread can 96069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * execute the main loop at any time. 97069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 98069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void run() { 99069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 100069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (this.workerThread == null) { 101069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.workerThread = Thread.currentThread(); 102069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 103069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 104069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project while (this.workerThread == Thread.currentThread()) { 105069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project try { 106069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project // remove the next reference and process it 107069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Reference<?> ref = refQueue.remove(); 108069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project refHandler.handleReference(ref); 109069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } catch (InterruptedException e) { 110069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project //@@@ is logging really necessary? this here is the 111069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project //@@@ only reason for having a log in this class 112069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (log.isDebugEnabled()) { 113069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project log.debug(this.toString() + " interrupted", e); 114069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 115069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 116069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 117069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 118069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 119069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 120069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 121069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Shuts down this worker. 122069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * It can be re-started afterwards by another call to {@link #run run()}. 123069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 124069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public void shutdown() { 125069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project Thread wt = this.workerThread; 126069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project if (wt != null) { 127069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project this.workerThread = null; // indicate shutdown 128069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project wt.interrupt(); 129069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 130069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 131069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 132069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 133069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project /** 134069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * Obtains a description of this worker. 135069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * 136069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project * @return a descriptive string for this worker 137069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project */ 138069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project @Override 139069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project public String toString() { 140069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project return "RefQueueWorker::" + this.workerThread; 141069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project } 142069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 143069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project} // class RefQueueWorker 144069490a5ca2fd1988d29daf45d892f47ad665115The Android Open Source Project 145