mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/EofSensorWatcher.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/EofSensorWatcher.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 | * |
| michael@0 | 4 | * Licensed to the Apache Software Foundation (ASF) under one or more |
| michael@0 | 5 | * contributor license agreements. See the NOTICE file distributed with |
| michael@0 | 6 | * this work for additional information regarding copyright ownership. |
| michael@0 | 7 | * The ASF licenses this file to You under the Apache License, Version 2.0 |
| michael@0 | 8 | * (the "License"); you may not use this file except in compliance with |
| michael@0 | 9 | * 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, software |
| michael@0 | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
| michael@0 | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| michael@0 | 16 | * See the License for the specific language governing permissions and |
| michael@0 | 17 | * limitations under the License. |
| michael@0 | 18 | * ==================================================================== |
| michael@0 | 19 | * |
| michael@0 | 20 | * This software consists of voluntary contributions made by many |
| michael@0 | 21 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 22 | * information on the Apache Software Foundation, please see |
| michael@0 | 23 | * <http://www.apache.org/>. |
| michael@0 | 24 | * |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | package ch.boye.httpclientandroidlib.conn; |
| michael@0 | 28 | |
| michael@0 | 29 | import java.io.InputStream; |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | |
| michael@0 | 32 | /** |
| michael@0 | 33 | * A watcher for {@link EofSensorInputStream}. Each stream will notify its |
| michael@0 | 34 | * watcher at most once. |
| michael@0 | 35 | * |
| michael@0 | 36 | * @since 4.0 |
| michael@0 | 37 | */ |
| michael@0 | 38 | public interface EofSensorWatcher { |
| michael@0 | 39 | |
| michael@0 | 40 | /** |
| michael@0 | 41 | * Indicates that EOF is detected. |
| michael@0 | 42 | * |
| michael@0 | 43 | * @param wrapped the underlying stream which has reached EOF |
| michael@0 | 44 | * |
| michael@0 | 45 | * @return <code>true</code> if <code>wrapped</code> should be closed, |
| michael@0 | 46 | * <code>false</code> if it should be left alone |
| michael@0 | 47 | * |
| michael@0 | 48 | * @throws IOException |
| michael@0 | 49 | * in case of an IO problem, for example if the watcher itself |
| michael@0 | 50 | * closes the underlying stream. The caller will leave the |
| michael@0 | 51 | * wrapped stream alone, as if <code>false</code> was returned. |
| michael@0 | 52 | */ |
| michael@0 | 53 | boolean eofDetected(InputStream wrapped) |
| michael@0 | 54 | throws IOException; |
| michael@0 | 55 | |
| michael@0 | 56 | /** |
| michael@0 | 57 | * Indicates that the {@link EofSensorInputStream stream} is closed. |
| michael@0 | 58 | * This method will be called only if EOF was <i>not</i> detected |
| michael@0 | 59 | * before closing. Otherwise, {@link #eofDetected eofDetected} is called. |
| michael@0 | 60 | * |
| michael@0 | 61 | * @param wrapped the underlying stream which has not reached EOF |
| michael@0 | 62 | * |
| michael@0 | 63 | * @return <code>true</code> if <code>wrapped</code> should be closed, |
| michael@0 | 64 | * <code>false</code> if it should be left alone |
| michael@0 | 65 | * |
| michael@0 | 66 | * @throws IOException |
| michael@0 | 67 | * in case of an IO problem, for example if the watcher itself |
| michael@0 | 68 | * closes the underlying stream. The caller will leave the |
| michael@0 | 69 | * wrapped stream alone, as if <code>false</code> was returned. |
| michael@0 | 70 | */ |
| michael@0 | 71 | boolean streamClosed(InputStream wrapped) |
| michael@0 | 72 | throws IOException; |
| michael@0 | 73 | |
| michael@0 | 74 | /** |
| michael@0 | 75 | * Indicates that the {@link EofSensorInputStream stream} is aborted. |
| michael@0 | 76 | * This method will be called only if EOF was <i>not</i> detected |
| michael@0 | 77 | * before aborting. Otherwise, {@link #eofDetected eofDetected} is called. |
| michael@0 | 78 | * <p/> |
| michael@0 | 79 | * This method will also be invoked when an input operation causes an |
| michael@0 | 80 | * IOException to be thrown to make sure the input stream gets shut down. |
| michael@0 | 81 | * |
| michael@0 | 82 | * @param wrapped the underlying stream which has not reached EOF |
| michael@0 | 83 | * |
| michael@0 | 84 | * @return <code>true</code> if <code>wrapped</code> should be closed, |
| michael@0 | 85 | * <code>false</code> if it should be left alone |
| michael@0 | 86 | * |
| michael@0 | 87 | * @throws IOException |
| michael@0 | 88 | * in case of an IO problem, for example if the watcher itself |
| michael@0 | 89 | * closes the underlying stream. The caller will leave the |
| michael@0 | 90 | * wrapped stream alone, as if <code>false</code> was returned. |
| michael@0 | 91 | */ |
| michael@0 | 92 | boolean streamAbort(InputStream wrapped) |
| michael@0 | 93 | throws IOException; |
| michael@0 | 94 | |
| michael@0 | 95 | } |
