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.http.nio.reactor;
29  
30  /**
31   * IOEventDispatch interface is used by I/O reactors to notify clients of I/O
32   * events pending for a particular session. All methods of this interface are
33   * executed on a dispatch thread of the I/O reactor. Therefore, it is important
34   * that processing that takes place in the event methods will not block the
35   * dispatch thread for too long, as the I/O reactor will be unable to react to
36   * other events.
37   *
38   * @since 4.0
39   */
40  public interface IOEventDispatch {
41  
42      /**
43       * Attribute name of an object that represents a non-blocking connection.
44       */
45      public static final String CONNECTION_KEY = "http.connection";
46  
47      /**
48       * Triggered after the given session has been just created.
49       *
50       * @param session the I/O session.
51       */
52      void connected(IOSession session);
53  
54      /**
55       * Triggered when the given session has input pending.
56       *
57       * @param session the I/O session.
58       */
59      void inputReady(IOSession session);
60  
61      /**
62       * Triggered when the given session is ready for output.
63       *
64       * @param session the I/O session.
65       */
66      void outputReady(IOSession session);
67  
68      /**
69       * Triggered when the given session as timed out.
70       *
71       * @param session the I/O session.
72       */
73      void timeout(IOSession session);
74  
75      /**
76       * Triggered when the given session has been terminated.
77       *
78       * @param session the I/O session.
79       */
80      void disconnected(IOSession session);
81  
82  }