mobile/android/thirdparty/ch/boye/httpclientandroidlib/HttpClientConnection.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/HttpClientConnection.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * A client-side HTTP connection, which can be used for sending |
| michael@0 | 34 | * requests and receiving responses. |
| michael@0 | 35 | * |
| michael@0 | 36 | * @since 4.0 |
| michael@0 | 37 | */ |
| michael@0 | 38 | public interface HttpClientConnection extends HttpConnection { |
| michael@0 | 39 | |
| michael@0 | 40 | /** |
| michael@0 | 41 | * Checks if response data is available from the connection. May wait for |
| michael@0 | 42 | * the specified time until some data becomes available. Note that some |
| michael@0 | 43 | * implementations may completely ignore the timeout parameter. |
| michael@0 | 44 | * |
| michael@0 | 45 | * @param timeout the maximum time in milliseconds to wait for data |
| michael@0 | 46 | * @return true if data is available; false if there was no data available |
| michael@0 | 47 | * even after waiting for <code>timeout</code> milliseconds. |
| michael@0 | 48 | * @throws IOException if an error happens on the connection |
| michael@0 | 49 | */ |
| michael@0 | 50 | boolean isResponseAvailable(int timeout) |
| michael@0 | 51 | throws IOException; |
| michael@0 | 52 | |
| michael@0 | 53 | /** |
| michael@0 | 54 | * Sends the request line and all headers over the connection. |
| michael@0 | 55 | * @param request the request whose headers to send. |
| michael@0 | 56 | * @throws HttpException in case of HTTP protocol violation |
| michael@0 | 57 | * @throws IOException in case of an I/O error |
| michael@0 | 58 | */ |
| michael@0 | 59 | void sendRequestHeader(HttpRequest request) |
| michael@0 | 60 | throws HttpException, IOException; |
| michael@0 | 61 | |
| michael@0 | 62 | /** |
| michael@0 | 63 | * Sends the request entity over the connection. |
| michael@0 | 64 | * @param request the request whose entity to send. |
| michael@0 | 65 | * @throws HttpException in case of HTTP protocol violation |
| michael@0 | 66 | * @throws IOException in case of an I/O error |
| michael@0 | 67 | */ |
| michael@0 | 68 | void sendRequestEntity(HttpEntityEnclosingRequest request) |
| michael@0 | 69 | throws HttpException, IOException; |
| michael@0 | 70 | |
| michael@0 | 71 | /** |
| michael@0 | 72 | * Receives the request line and headers of the next response available from |
| michael@0 | 73 | * this connection. The caller should examine the HttpResponse object to |
| michael@0 | 74 | * find out if it should try to receive a response entity as well. |
| michael@0 | 75 | * |
| michael@0 | 76 | * @return a new HttpResponse object with status line and headers |
| michael@0 | 77 | * initialized. |
| michael@0 | 78 | * @throws HttpException in case of HTTP protocol violation |
| michael@0 | 79 | * @throws IOException in case of an I/O error |
| michael@0 | 80 | */ |
| michael@0 | 81 | HttpResponse receiveResponseHeader() |
| michael@0 | 82 | throws HttpException, IOException; |
| michael@0 | 83 | |
| michael@0 | 84 | /** |
| michael@0 | 85 | * Receives the next response entity available from this connection and |
| michael@0 | 86 | * attaches it to an existing HttpResponse object. |
| michael@0 | 87 | * |
| michael@0 | 88 | * @param response the response to attach the entity to |
| michael@0 | 89 | * @throws HttpException in case of HTTP protocol violation |
| michael@0 | 90 | * @throws IOException in case of an I/O error |
| michael@0 | 91 | */ |
| michael@0 | 92 | void receiveResponseEntity(HttpResponse response) |
| michael@0 | 93 | throws HttpException, IOException; |
| michael@0 | 94 | |
| michael@0 | 95 | /** |
| michael@0 | 96 | * Writes out all pending buffered data over the open connection. |
| michael@0 | 97 | * |
| michael@0 | 98 | * @throws IOException in case of an I/O error |
| michael@0 | 99 | */ |
| michael@0 | 100 | void flush() throws IOException; |
| michael@0 | 101 | |
| michael@0 | 102 | } |
