View Javadoc

    1   /*
    2    * Copyright 2012 The Netty Project
    3    *
    4    * The Netty Project licenses this file to you under the Apache License,
    5    * version 2.0 (the "License"); you may not use this file except in compliance
    6    * with the 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  public interface ChildChannelStateEvent extends ChannelEvent {
    25
    26      /**
    27       * Returns the <strong>parent</strong> {@link Channel} which is associated
    28       * with this event.  Please note that you should use {@link #getChildChannel()}
    29       * to get the {@link Channel} created or accepted by the parent {@link Channel}.
    30       */
    31      Channel getChannel();
    32
    33      /**
    34       * Returns the child {@link Channel} whose state has been changed.
    35       */
    36      Channel getChildChannel();
    37  }