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
030/**
031 * IOEventDispatch interface is used by I/O reactors to notify clients of I/O
032 * events pending for a particular session. All methods of this interface are
033 * executed on a dispatch thread of the I/O reactor. Therefore, it is important
034 * that processing that takes place in the event methods will not block the
035 * dispatch thread for too long, as the I/O reactor will be unable to react to
036 * other events.
037 *
038 * @since 4.0
039 */
040public interface IOEventDispatch {
041
042    /**
043     * Attribute name of an object that represents a non-blocking connection.
044     */
045    public static final String CONNECTION_KEY = "http.connection";
046
047    /**
048     * Triggered after the given session has been just created.
049     *
050     * @param session the I/O session.
051     */
052    void connected(IOSession session);
053
054    /**
055     * Triggered when the given session has input pending.
056     *
057     * @param session the I/O session.
058     */
059    void inputReady(IOSession session);
060
061    /**
062     * Triggered when the given session is ready for output.
063     *
064     * @param session the I/O session.
065     */
066    void outputReady(IOSession session);
067
068    /**
069     * Triggered when the given session as timed out.
070     *
071     * @param session the I/O session.
072     */
073    void timeout(IOSession session);
074
075    /**
076     * Triggered when the given session has been terminated.
077     *
078     * @param session the I/O session.
079     */
080    void disconnected(IOSession session);
081
082}