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;
029
030import java.io.IOException;
031
032/**
033 * Connection input/output control interface. It can be used to control interest
034 * in I/O event notifications for non-blocking HTTP connections.
035 * <p>
036 * Implementations of this interface are expected to be threading safe.
037 * Therefore it can be used to request / suspend I/O event notifications from
038 * any thread of execution.
039 *
040 * @since 4.0
041 */
042public interface IOControl {
043
044    /**
045     * Requests event notifications to be triggered when the underlying
046     * channel is ready for input operations.
047     */
048    void requestInput();
049
050    /**
051     * Suspends event notifications about the underlying channel being
052     * ready for input operations.
053     */
054    void suspendInput();
055
056    /**
057     * Requests event notifications to be triggered when the underlying
058     * channel is ready for output operations.
059     */
060    void requestOutput();
061
062    /**
063     * Suspends event notifications about the underlying channel being
064     * ready for output operations.
065     */
066    void suspendOutput();
067
068    /**
069     * Shuts down the underlying channel.
070     *
071     * @throws IOException in an error occurs
072     */
073    void shutdown() throws IOException;
074
075}