View Javadoc
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.hc.core5.reactor;
29  
30  import java.io.IOException;
31  
32  import org.apache.hc.core5.util.Timeout;
33  
34  /**
35   * IOEventHandler interface is used by I/O reactors to handle I/O events for individual
36   * I/O sessions. All methods of this interface are executed on a single dispatch thread
37   * of the I/O reactor. Therefore, it is important that event processing does not not block
38   * the I/O dispatch thread for too long, thus making the I/O reactor unable to react to
39   * other events.
40   *
41   * @since 5.0
42   */
43  public interface IOEventHandler {
44  
45      /**
46       * Triggered after the given session has been just created.
47       *
48       * @param session the I/O session.
49       */
50      void connected(IOSession session) throws IOException;
51  
52      /**
53       * Triggered when the given session has input pending.
54       *
55       * @param session the I/O session.
56       */
57      void inputReady(IOSession session) throws IOException;
58  
59      /**
60       * Triggered when the given session is ready for output.
61       *
62       * @param session the I/O session.
63       */
64      void outputReady(IOSession session) throws IOException;
65  
66      /**
67       * Triggered when the given session has timed out.
68       *
69       * @param session the I/O session.
70       * @param timeout the timeout.
71       */
72      void timeout(IOSession session, Timeout timeout) throws IOException;
73  
74      /**
75       * Triggered when the given session throws a exception.
76       *
77       * @param session the I/O session.
78       */
79      void exception(IOSession session, Exception cause);
80  
81      /**
82       * Triggered when the given session has been terminated.
83       *
84       * @param session the I/O session.
85       */
86      void disconnected(IOSession session);
87  
88  }