Home | History | Annotate | Download | only in io 
      1 /*
      2  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpcore/trunk/module-main/src/main/java/org/apache/http/impl/io/SocketInputBuffer.java $
      3  * $Revision: 560358 $
      4  * $Date: 2007-07-27 12:30:42 -0700 (Fri, 27 Jul 2007) $
      5  *
      6  * ====================================================================
      7  * Licensed to the Apache Software Foundation (ASF) under one
      8  * or more contributor license agreements.  See the NOTICE file
      9  * distributed with this work for additional information
     10  * regarding copyright ownership.  The ASF licenses this file
     11  * to you under the Apache License, Version 2.0 (the
     12  * "License"); you may not use this file except in compliance
     13  * with the License.  You may obtain a copy of the License at
     14  *
     15  *   http://www.apache.org/licenses/LICENSE-2.0
     16  *
     17  * Unless required by applicable law or agreed to in writing,
     18  * software distributed under the License is distributed on an
     19  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     20  * KIND, either express or implied.  See the License for the
     21  * specific language governing permissions and limitations
     22  * under the License.
     23  * ====================================================================
     24  *
     25  * This software consists of voluntary contributions made by many
     26  * individuals on behalf of the Apache Software Foundation.  For more
     27  * information on the Apache Software Foundation, please see
     28  * <http://www.apache.org/>.
     29  *
     30  */
     31 
     32 package org.apache.http.impl.io;
     33 
     34 import java.io.IOException;
     35 import java.io.InterruptedIOException;
     36 import java.net.Socket;
     37 import java.net.SocketTimeoutException;
     38 
     39 import java.net.SocketTimeoutException;
     40 import org.apache.http.params.HttpParams;
     41 
     42 
     43 /**
     44  * {@link Socket} bound session input buffer.
     45  *
     46  * @author <a href="mailto:oleg at ural.ru">Oleg Kalnichevski</a>
     47  *
     48  * @version $Revision: 560358 $
     49  *
     50  * @since 4.0
     51  *
     52  * @deprecated Please use {@link java.net.URL#openConnection} instead.
     53  *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
     54  *     for further details.
     55  */
     56 @Deprecated
     57 public class SocketInputBuffer extends AbstractSessionInputBuffer {
     58 
     59     private final Socket socket;
     60 
     61     public SocketInputBuffer(
     62             final Socket socket,
     63             int buffersize,
     64             final HttpParams params) throws IOException {
     65         super();
     66         if (socket == null) {
     67             throw new IllegalArgumentException("Socket may not be null");
     68         }
     69         this.socket = socket;
     70         // BEGIN android-changed
     71         // Workaround for http://b/3514259. We take 'buffersize' as a hint in
     72         // the weakest sense, and always use an 8KiB heap buffer and leave the
     73         // kernel buffer size alone, trusting the system to have set a
     74         // network-appropriate default.
     75         init(socket.getInputStream(), 8192, params);
     76         // END android-changed
     77     }
     78 
     79     public boolean isDataAvailable(int timeout) throws IOException {
     80         boolean result = hasBufferedData();
     81         if (!result) {
     82             int oldtimeout = this.socket.getSoTimeout();
     83             try {
     84                 this.socket.setSoTimeout(timeout);
     85                 fillBuffer();
     86                 result = hasBufferedData();
     87             } catch (InterruptedIOException e) {
     88                 if (!(e instanceof SocketTimeoutException)) {
     89                     throw e;
     90                 }
     91             } finally {
     92                 socket.setSoTimeout(oldtimeout);
     93             }
     94         }
     95         return result;
     96     }
     97 
     98     // BEGIN android-added
     99     /**
    100      * Returns true if the connection is probably functional. It's insufficient
    101      * to rely on isDataAvailable() returning normally; that approach cannot
    102      * distinguish between an exhausted stream and a stream with zero bytes
    103      * buffered.
    104      */
    105     public boolean isStale() throws IOException {
    106         if (hasBufferedData()) {
    107             return false;
    108         }
    109         int oldTimeout = this.socket.getSoTimeout();
    110         try {
    111             this.socket.setSoTimeout(1);
    112             return fillBuffer() == -1;
    113         } catch (SocketTimeoutException e) {
    114             return false; // the connection is not stale; hooray
    115         } catch (IOException e) {
    116             return true; // the connection is stale, the read or soTimeout failed.
    117         } finally {
    118             this.socket.setSoTimeout(oldTimeout);
    119         }
    120     }
    121     // END android-added
    122 }
    123