netty5/src/main/java/org/jboss/netty/channel/ChildChannelStateEvent.java

43 lines
1.6 KiB
Java

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