View Javadoc

1   /*
2    * Copyright 2009 Red Hat, Inc.
3    *
4    * Red Hat licenses this file to you under the Apache License, version 2.0
5    * (the "License"); you may not use this file except in compliance with the
6    * License.  You may obtain a copy of the License at:
7    *
8    *    http://www.apache.org/licenses/LICENSE-2.0
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
13   * License for the specific language governing permissions and limitations
14   * under the License.
15   */
16  package org.jboss.netty.channel;
17  
18  /**
19   * A {@link ChannelEvent} which represents the notification of the state of
20   * a child {@link Channel}.  This event is for going upstream only.  Please
21   * refer to the {@link ChannelEvent} documentation to find out what an upstream
22   * event and a downstream event are and what fundamental differences they have.
23   *
24   * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
25   * @author <a href="http://gleamynode.net/">Trustin Lee</a>
26   *
27   * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
28   */
29  public interface ChildChannelStateEvent extends ChannelEvent {
30  
31      /**
32       * Returns the <strong>parent</strong> {@link Channel} which is associated
33       * with this event.  Please note that you should use {@link #getChildChannel()}
34       * to get the {@link Channel} created or accepted by the parent {@link Channel}.
35       */
36      Channel getChannel();
37  
38      /**
39       * Returns the child {@link Channel} whose state has been changed.
40       */
41      Channel getChildChannel();
42  }