001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.nio.reactor;
029
030import java.io.IOException;
031
032/**
033 * Abstract exception handler intended to deal with potentially recoverable
034 * I/O exceptions thrown by an I/O reactor.
035 *
036 * @since 4.0
037 */
038public interface IOReactorExceptionHandler {
039
040    /**
041     * This method is expected to examine the I/O exception passed as
042     * a parameter and decide whether it is safe to continue execution of
043     * the I/O reactor.
044     *
045     * @param ex potentially recoverable I/O exception
046     * @return {@code true} if it is safe to ignore the exception
047     * and continue execution of the I/O reactor; {@code false} if the
048     * I/O reactor must throw {@link IOReactorException} and terminate
049     */
050    boolean handle(IOException ex);
051
052    /**
053     * This method is expected to examine the runtime exception passed as
054     * a parameter and decide whether it is safe to continue execution of
055     * the I/O reactor.
056     *
057     * @param ex potentially recoverable runtime exception
058     * @return {@code true} if it is safe to ignore the exception
059     * and continue execution of the I/O reactor; {@code false} if the
060     * I/O reactor must throw {@link RuntimeException} and terminate
061     */
062    boolean handle(RuntimeException ex);
063
064}