michael@0: /*
michael@0:  * ====================================================================
michael@0:  *
michael@0:  *  Licensed to the Apache Software Foundation (ASF) under one or more
michael@0:  *  contributor license agreements.  See the NOTICE file distributed with
michael@0:  *  this work for additional information regarding copyright ownership.
michael@0:  *  The ASF licenses this file to You under the Apache License, Version 2.0
michael@0:  *  (the "License"); you may not use this file except in compliance with
michael@0:  *  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, software
michael@0:  *  distributed under the License is distributed on an "AS IS" BASIS,
michael@0:  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
michael@0:  *  See the License for the specific language governing permissions and
michael@0:  *  limitations 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.conn;
michael@0: 
michael@0: import java.io.InputStream;
michael@0: import java.io.IOException;
michael@0: 
michael@0: /**
michael@0:  * A watcher for {@link EofSensorInputStream}. Each stream will notify its
michael@0:  * watcher at most once.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface EofSensorWatcher {
michael@0: 
michael@0:     /**
michael@0:      * Indicates that EOF is detected.
michael@0:      *
michael@0:      * @param wrapped   the underlying stream which has reached EOF
michael@0:      *
michael@0:      * @return  <code>true</code> if <code>wrapped</code> should be closed,
michael@0:      *          <code>false</code> if it should be left alone
michael@0:      *
michael@0:      * @throws IOException
michael@0:      *         in case of an IO problem, for example if the watcher itself
michael@0:      *         closes the underlying stream. The caller will leave the
michael@0:      *         wrapped stream alone, as if <code>false</code> was returned.
michael@0:      */
michael@0:     boolean eofDetected(InputStream wrapped)
michael@0:         throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Indicates that the {@link EofSensorInputStream stream} is closed.
michael@0:      * This method will be called only if EOF was <i>not</i> detected
michael@0:      * before closing. Otherwise, {@link #eofDetected eofDetected} is called.
michael@0:      *
michael@0:      * @param wrapped   the underlying stream which has not reached EOF
michael@0:      *
michael@0:      * @return  <code>true</code> if <code>wrapped</code> should be closed,
michael@0:      *          <code>false</code> if it should be left alone
michael@0:      *
michael@0:      * @throws IOException
michael@0:      *         in case of an IO problem, for example if the watcher itself
michael@0:      *         closes the underlying stream. The caller will leave the
michael@0:      *         wrapped stream alone, as if <code>false</code> was returned.
michael@0:      */
michael@0:     boolean streamClosed(InputStream wrapped)
michael@0:         throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Indicates that the {@link EofSensorInputStream stream} is aborted.
michael@0:      * This method will be called only if EOF was <i>not</i> detected
michael@0:      * before aborting. Otherwise, {@link #eofDetected eofDetected} is called.
michael@0:      * <p/>
michael@0:      * This method will also be invoked when an input operation causes an
michael@0:      * IOException to be thrown to make sure the input stream gets shut down.
michael@0:      *
michael@0:      * @param wrapped   the underlying stream which has not reached EOF
michael@0:      *
michael@0:      * @return  <code>true</code> if <code>wrapped</code> should be closed,
michael@0:      *          <code>false</code> if it should be left alone
michael@0:      *
michael@0:      * @throws IOException
michael@0:      *         in case of an IO problem, for example if the watcher itself
michael@0:      *         closes the underlying stream. The caller will leave the
michael@0:      *         wrapped stream alone, as if <code>false</code> was returned.
michael@0:      */
michael@0:     boolean streamAbort(InputStream wrapped)
michael@0:         throws IOException;
michael@0: 
michael@0: }