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;
michael@0: 
michael@0: import java.io.IOException;
michael@0: 
michael@0: /**
michael@0:  * A client-side HTTP connection, which can be used for sending
michael@0:  * requests and receiving responses.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface HttpClientConnection extends HttpConnection {
michael@0: 
michael@0:     /**
michael@0:      * Checks if response data is available from the connection. May wait for
michael@0:      * the specified time until some data becomes available. Note that some
michael@0:      * implementations may completely ignore the timeout parameter.
michael@0:      *
michael@0:      * @param timeout the maximum time in milliseconds to wait for data
michael@0:      * @return true if data is available; false if there was no data available
michael@0:      *         even after waiting for <code>timeout</code> milliseconds.
michael@0:      * @throws IOException if an error happens on the connection
michael@0:      */
michael@0:     boolean isResponseAvailable(int timeout)
michael@0:         throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Sends the request line and all headers over the connection.
michael@0:      * @param request the request whose headers to send.
michael@0:      * @throws HttpException in case of HTTP protocol violation
michael@0:      * @throws IOException in case of an I/O error
michael@0:      */
michael@0:     void sendRequestHeader(HttpRequest request)
michael@0:         throws HttpException, IOException;
michael@0: 
michael@0:     /**
michael@0:      * Sends the request entity over the connection.
michael@0:      * @param request the request whose entity to send.
michael@0:      * @throws HttpException in case of HTTP protocol violation
michael@0:      * @throws IOException in case of an I/O error
michael@0:      */
michael@0:     void sendRequestEntity(HttpEntityEnclosingRequest request)
michael@0:         throws HttpException, IOException;
michael@0: 
michael@0:     /**
michael@0:      * Receives the request line and headers of the next response available from
michael@0:      * this connection. The caller should examine the HttpResponse object to
michael@0:      * find out if it should try to receive a response entity as well.
michael@0:      *
michael@0:      * @return a new HttpResponse object with status line and headers
michael@0:      *         initialized.
michael@0:      * @throws HttpException in case of HTTP protocol violation
michael@0:      * @throws IOException in case of an I/O error
michael@0:      */
michael@0:     HttpResponse receiveResponseHeader()
michael@0:         throws HttpException, IOException;
michael@0: 
michael@0:     /**
michael@0:      * Receives the next response entity available from this connection and
michael@0:      * attaches it to an existing HttpResponse object.
michael@0:      *
michael@0:      * @param response the response to attach the entity to
michael@0:      * @throws HttpException in case of HTTP protocol violation
michael@0:      * @throws IOException in case of an I/O error
michael@0:      */
michael@0:     void receiveResponseEntity(HttpResponse response)
michael@0:         throws HttpException, IOException;
michael@0: 
michael@0:     /**
michael@0:      * Writes out all pending buffered data over the open connection.
michael@0:      *
michael@0:      * @throws IOException in case of an I/O error
michael@0:      */
michael@0:     void flush() throws IOException;
michael@0: 
michael@0: }