mobile/android/thirdparty/ch/boye/httpclientandroidlib/HttpConnection.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/HttpConnection.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 generic HTTP connection, useful on client and server side. |
| michael@0 | 34 | * |
| michael@0 | 35 | * @since 4.0 |
| michael@0 | 36 | */ |
| michael@0 | 37 | public interface HttpConnection { |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * Closes this connection gracefully. |
| michael@0 | 41 | * This method will attempt to flush the internal output |
| michael@0 | 42 | * buffer prior to closing the underlying socket. |
| michael@0 | 43 | * This method MUST NOT be called from a different thread to force |
| michael@0 | 44 | * shutdown of the connection. Use {@link #shutdown shutdown} instead. |
| michael@0 | 45 | */ |
| michael@0 | 46 | public void close() throws IOException; |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Checks if this connection is open. |
| michael@0 | 50 | * @return true if it is open, false if it is closed. |
| michael@0 | 51 | */ |
| michael@0 | 52 | public boolean isOpen(); |
| michael@0 | 53 | |
| michael@0 | 54 | /** |
| michael@0 | 55 | * Checks whether this connection has gone down. |
| michael@0 | 56 | * Network connections may get closed during some time of inactivity |
| michael@0 | 57 | * for several reasons. The next time a read is attempted on such a |
| michael@0 | 58 | * connection it will throw an IOException. |
| michael@0 | 59 | * This method tries to alleviate this inconvenience by trying to |
| michael@0 | 60 | * find out if a connection is still usable. Implementations may do |
| michael@0 | 61 | * that by attempting a read with a very small timeout. Thus this |
| michael@0 | 62 | * method may block for a small amount of time before returning a result. |
| michael@0 | 63 | * It is therefore an <i>expensive</i> operation. |
| michael@0 | 64 | * |
| michael@0 | 65 | * @return <code>true</code> if attempts to use this connection are |
| michael@0 | 66 | * likely to succeed, or <code>false</code> if they are likely |
| michael@0 | 67 | * to fail and this connection should be closed |
| michael@0 | 68 | */ |
| michael@0 | 69 | public boolean isStale(); |
| michael@0 | 70 | |
| michael@0 | 71 | /** |
| michael@0 | 72 | * Sets the socket timeout value. |
| michael@0 | 73 | * |
| michael@0 | 74 | * @param timeout timeout value in milliseconds |
| michael@0 | 75 | */ |
| michael@0 | 76 | void setSocketTimeout(int timeout); |
| michael@0 | 77 | |
| michael@0 | 78 | /** |
| michael@0 | 79 | * Returns the socket timeout value. |
| michael@0 | 80 | * |
| michael@0 | 81 | * @return positive value in milliseconds if a timeout is set, |
| michael@0 | 82 | * <code>0</code> if timeout is disabled or <code>-1</code> if |
| michael@0 | 83 | * timeout is undefined. |
| michael@0 | 84 | */ |
| michael@0 | 85 | int getSocketTimeout(); |
| michael@0 | 86 | |
| michael@0 | 87 | /** |
| michael@0 | 88 | * Force-closes this connection. |
| michael@0 | 89 | * This is the only method of a connection which may be called |
| michael@0 | 90 | * from a different thread to terminate the connection. |
| michael@0 | 91 | * This method will not attempt to flush the transmitter's |
| michael@0 | 92 | * internal buffer prior to closing the underlying socket. |
| michael@0 | 93 | */ |
| michael@0 | 94 | public void shutdown() throws IOException; |
| michael@0 | 95 | |
| michael@0 | 96 | /** |
| michael@0 | 97 | * Returns a collection of connection metrics. |
| michael@0 | 98 | * |
| michael@0 | 99 | * @return HttpConnectionMetrics |
| michael@0 | 100 | */ |
| michael@0 | 101 | HttpConnectionMetrics getMetrics(); |
| michael@0 | 102 | |
| michael@0 | 103 | } |
