httpcore5/src/main/java/org/apache/hc/core5/reactor/IOEventHandler.java

/*
 * ====================================================================
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 *
 */

package org.apache.hc.core5.reactor;

import java.io.IOException;
import java.nio.ByteBuffer;

import org.apache.hc.core5.annotation.Internal;
import org.apache.hc.core5.util.Timeout;

/**
 * IOEventHandler interface is used by I/O reactors to handle I/O events for individual
 * I/O sessions. All methods of this interface are executed on a single dispatch thread
 * of the I/O reactor. Therefore, it is important that event processing does not not block
 * the I/O dispatch thread for too long, thus making the I/O reactor unable to react to
 * other events.
 *
 * @since 5.0
 */
@Internal
public interface IOEventHandler {

    /**
     * Triggered after the given session has been just created.
     *
     * @param session the I/O session.
     */
    void connected(IOSession session) throws IOException;

    /**
     * Triggered when the given session has input pending.
     *
     * @param session the I/O session.
     */
    void inputReady(IOSession session, ByteBuffer src) throws IOException;

    /**
     * Triggered when the given session is ready for output.
     *
     * @param session the I/O session.
     */
    void outputReady(IOSession session) throws IOException;

    /**
     * Triggered when the given session has timed out.
     *
     * @param session the I/O session.
     * @param timeout the timeout.
     */
    void timeout(IOSession session, Timeout timeout) throws IOException;

    /**
     * Triggered when the given session throws a exception.
     *
     * @param session the I/O session.
     */
    void exception(IOSession session, Exception cause);

    /**
     * Triggered when the given session has been terminated.
     *
     * @param session the I/O session.
     */
    void disconnected(IOSession session);

}