1 /*
2 * ====================================================================
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements. See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership. The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied. See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 * ====================================================================
20 *
21 * This software consists of voluntary contributions made by many
22 * individuals on behalf of the Apache Software Foundation. For more
23 * information on the Apache Software Foundation, please see
24 * <http://www.apache.org/>.
25 *
26 */
27
28 package org.apache.http.nio;
29
30 import java.io.IOException;
31
32 /**
33 * Connection input/output control interface. It can be used to control interest
34 * in I/O event notifications for non-blocking HTTP connections.
35 * <p>
36 * Implementations of this interface are expected to be threading safe.
37 * Therefore it can be used to request / suspend I/O event notifications from
38 * any thread of execution.
39 *
40 * @since 4.0
41 */
42 public interface IOControl {
43
44 /**
45 * Requests event notifications to be triggered when the underlying
46 * channel is ready for input operations.
47 */
48 void requestInput();
49
50 /**
51 * Suspends event notifications about the underlying channel being
52 * ready for input operations.
53 */
54 void suspendInput();
55
56 /**
57 * Requests event notifications to be triggered when the underlying
58 * channel is ready for output operations.
59 */
60 void requestOutput();
61
62 /**
63 * Suspends event notifications about the underlying channel being
64 * ready for output operations.
65 */
66 void suspendOutput();
67
68 /**
69 * Shuts down the underlying channel.
70 *
71 * @throws IOException in an error occurs
72 */
73 void shutdown() throws IOException;
74
75 }