1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/EofSensorWatcher.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,95 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + *
1.7 + * Licensed to the Apache Software Foundation (ASF) under one or more
1.8 + * contributor license agreements. See the NOTICE file distributed with
1.9 + * this work for additional information regarding copyright ownership.
1.10 + * The ASF licenses this file to You under the Apache License, Version 2.0
1.11 + * (the "License"); you may not use this file except in compliance with
1.12 + * the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing, software
1.17 + * distributed under the License is distributed on an "AS IS" BASIS,
1.18 + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1.19 + * See the License for the specific language governing permissions and
1.20 + * limitations under the License.
1.21 + * ====================================================================
1.22 + *
1.23 + * This software consists of voluntary contributions made by many
1.24 + * individuals on behalf of the Apache Software Foundation. For more
1.25 + * information on the Apache Software Foundation, please see
1.26 + * <http://www.apache.org/>.
1.27 + *
1.28 + */
1.29 +
1.30 +package ch.boye.httpclientandroidlib.conn;
1.31 +
1.32 +import java.io.InputStream;
1.33 +import java.io.IOException;
1.34 +
1.35 +/**
1.36 + * A watcher for {@link EofSensorInputStream}. Each stream will notify its
1.37 + * watcher at most once.
1.38 + *
1.39 + * @since 4.0
1.40 + */
1.41 +public interface EofSensorWatcher {
1.42 +
1.43 + /**
1.44 + * Indicates that EOF is detected.
1.45 + *
1.46 + * @param wrapped the underlying stream which has reached EOF
1.47 + *
1.48 + * @return <code>true</code> if <code>wrapped</code> should be closed,
1.49 + * <code>false</code> if it should be left alone
1.50 + *
1.51 + * @throws IOException
1.52 + * in case of an IO problem, for example if the watcher itself
1.53 + * closes the underlying stream. The caller will leave the
1.54 + * wrapped stream alone, as if <code>false</code> was returned.
1.55 + */
1.56 + boolean eofDetected(InputStream wrapped)
1.57 + throws IOException;
1.58 +
1.59 + /**
1.60 + * Indicates that the {@link EofSensorInputStream stream} is closed.
1.61 + * This method will be called only if EOF was <i>not</i> detected
1.62 + * before closing. Otherwise, {@link #eofDetected eofDetected} is called.
1.63 + *
1.64 + * @param wrapped the underlying stream which has not reached EOF
1.65 + *
1.66 + * @return <code>true</code> if <code>wrapped</code> should be closed,
1.67 + * <code>false</code> if it should be left alone
1.68 + *
1.69 + * @throws IOException
1.70 + * in case of an IO problem, for example if the watcher itself
1.71 + * closes the underlying stream. The caller will leave the
1.72 + * wrapped stream alone, as if <code>false</code> was returned.
1.73 + */
1.74 + boolean streamClosed(InputStream wrapped)
1.75 + throws IOException;
1.76 +
1.77 + /**
1.78 + * Indicates that the {@link EofSensorInputStream stream} is aborted.
1.79 + * This method will be called only if EOF was <i>not</i> detected
1.80 + * before aborting. Otherwise, {@link #eofDetected eofDetected} is called.
1.81 + * <p/>
1.82 + * This method will also be invoked when an input operation causes an
1.83 + * IOException to be thrown to make sure the input stream gets shut down.
1.84 + *
1.85 + * @param wrapped the underlying stream which has not reached EOF
1.86 + *
1.87 + * @return <code>true</code> if <code>wrapped</code> should be closed,
1.88 + * <code>false</code> if it should be left alone
1.89 + *
1.90 + * @throws IOException
1.91 + * in case of an IO problem, for example if the watcher itself
1.92 + * closes the underlying stream. The caller will leave the
1.93 + * wrapped stream alone, as if <code>false</code> was returned.
1.94 + */
1.95 + boolean streamAbort(InputStream wrapped)
1.96 + throws IOException;
1.97 +
1.98 +}
