michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.impl.io;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.io.InterruptedIOException;
michael@0: import java.net.Socket;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.io.EofSensor;
michael@0: import ch.boye.httpclientandroidlib.io.SessionInputBuffer;
michael@0: import ch.boye.httpclientandroidlib.params.HttpParams;
michael@0: 
michael@0: /**
michael@0:  * {@link SessionInputBuffer} implementation bound to a {@link Socket}.
michael@0:  * <p>
michael@0:  * The following parameters can be used to customize the behavior of this
michael@0:  * class:
michael@0:  * <ul>
michael@0:  *  <li>{@link ch.boye.httpclientandroidlib.params.CoreProtocolPNames#HTTP_ELEMENT_CHARSET}</li>
michael@0:  *  <li>{@link ch.boye.httpclientandroidlib.params.CoreConnectionPNames#MAX_LINE_LENGTH}</li>
michael@0:  * </ul>
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public class SocketInputBuffer extends AbstractSessionInputBuffer implements EofSensor {
michael@0: 
michael@0:     static private final Class SOCKET_TIMEOUT_CLASS = SocketTimeoutExceptionClass();
michael@0: 
michael@0:     /**
michael@0:      * Returns <code>SocketTimeoutExceptionClass<code> or <code>null</code> if the class
michael@0:      * does not exist.
michael@0:      *
michael@0:      * @return <code>SocketTimeoutExceptionClass<code>, or <code>null</code> if unavailable.
michael@0:      */
michael@0:     static private Class SocketTimeoutExceptionClass() {
michael@0:         try {
michael@0:             return Class.forName("java.net.SocketTimeoutException");
michael@0:         } catch (ClassNotFoundException e) {
michael@0:             return null;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     private static boolean isSocketTimeoutException(final InterruptedIOException e) {
michael@0:         if (SOCKET_TIMEOUT_CLASS != null) {
michael@0:             return SOCKET_TIMEOUT_CLASS.isInstance(e);
michael@0:         } else {
michael@0:             return true;
michael@0:         }
michael@0:     }
michael@0: 
michael@0:     private final Socket socket;
michael@0: 
michael@0:     private boolean eof;
michael@0: 
michael@0:     /**
michael@0:      * Creates an instance of this class.
michael@0:      *
michael@0:      * @param socket the socket to read data from.
michael@0:      * @param buffersize the size of the internal buffer. If this number is less
michael@0:      *   than <code>0</code> it is set to the value of
michael@0:      *   {@link Socket#getReceiveBufferSize()}. If resultant number is less
michael@0:      *   than <code>1024</code> it is set to <code>1024</code>.
michael@0:      * @param params HTTP parameters.
michael@0:      */
michael@0:     public SocketInputBuffer(
michael@0:             final Socket socket,
michael@0:             int buffersize,
michael@0:             final HttpParams params) throws IOException {
michael@0:         super();
michael@0:         if (socket == null) {
michael@0:             throw new IllegalArgumentException("Socket may not be null");
michael@0:         }
michael@0:         this.socket = socket;
michael@0:         this.eof = false;
michael@0:         if (buffersize < 0) {
michael@0:             buffersize = socket.getReceiveBufferSize();
michael@0:         }
michael@0:         if (buffersize < 1024) {
michael@0:             buffersize = 1024;
michael@0:         }
michael@0:         init(socket.getInputStream(), buffersize, params);
michael@0:     }
michael@0: 
michael@0:     protected int fillBuffer() throws IOException {
michael@0:         int i = super.fillBuffer();
michael@0:         this.eof = i == -1;
michael@0:         return i;
michael@0:     }
michael@0: 
michael@0:     public boolean isDataAvailable(int timeout) throws IOException {
michael@0:         boolean result = hasBufferedData();
michael@0:         if (!result) {
michael@0:             int oldtimeout = this.socket.getSoTimeout();
michael@0:             try {
michael@0:                 this.socket.setSoTimeout(timeout);
michael@0:                 fillBuffer();
michael@0:                 result = hasBufferedData();
michael@0:             } catch (InterruptedIOException e) {
michael@0:                 if (!isSocketTimeoutException(e)) {
michael@0:                     throw e;
michael@0:                 }
michael@0:             } finally {
michael@0:                 socket.setSoTimeout(oldtimeout);
michael@0:             }
michael@0:         }
michael@0:         return result;
michael@0:     }
michael@0: 
michael@0:     public boolean isEof() {
michael@0:         return this.eof;
michael@0:     }
michael@0: 
michael@0: }