2008-08-08 02:37:18 +02:00
|
|
|
/*
|
2008-08-08 03:27:24 +02:00
|
|
|
* JBoss, Home of Professional Open Source
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
|
|
|
|
* by the @author tags. See the COPYRIGHT.txt in the distribution for a
|
|
|
|
* full listing of individual contributors.
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* This is free software; you can redistribute it and/or modify it
|
|
|
|
* under the terms of the GNU Lesser General Public License as
|
|
|
|
* published by the Free Software Foundation; either version 2.1 of
|
|
|
|
* the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This software is distributed in the hope that it will be useful,
|
2008-08-08 02:37:18 +02:00
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
2008-08-08 03:27:24 +02:00
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
2008-08-08 02:37:18 +02:00
|
|
|
* Lesser General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU Lesser General Public
|
2008-08-08 03:27:24 +02:00
|
|
|
* License along with this software; if not, write to the Free
|
|
|
|
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
|
|
|
|
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
|
2008-08-08 02:37:18 +02:00
|
|
|
*/
|
2008-08-08 03:40:10 +02:00
|
|
|
package org.jboss.netty.channel;
|
2008-08-08 02:37:18 +02:00
|
|
|
|
|
|
|
/**
|
2008-09-01 16:34:56 +02:00
|
|
|
* Handles or intercepts a {@link ChannelEvent}, and fires a
|
2008-09-01 17:19:34 +02:00
|
|
|
* {@link ChannelEvent} to the next or previous handler in a
|
|
|
|
* {@link ChannelPipeline}.
|
2008-09-02 16:12:56 +02:00
|
|
|
*
|
|
|
|
* <h3>Sub-types</h3>
|
2008-09-01 16:29:17 +02:00
|
|
|
* <p>
|
|
|
|
* This is a tag interface. There are two sub-interfaces which processes
|
|
|
|
* a received event actually, one for upstream events and the other for
|
|
|
|
* downstream events:
|
|
|
|
* <ul>
|
2008-09-02 16:12:56 +02:00
|
|
|
* <li>{@link ChannelUpstreamHandler} handles and intercepts a upstream {@link ChannelEvent}.</li>
|
|
|
|
* <li>{@link ChannelDownstreamHandler} handles and intercepts a downstream {@link ChannelEvent}.</li>
|
2008-09-01 16:29:17 +02:00
|
|
|
* </ul>
|
2008-09-02 16:12:56 +02:00
|
|
|
*
|
2008-09-03 05:46:54 +02:00
|
|
|
* You will also find more detailed explanation from the documentation of
|
|
|
|
* each sub-type about how an event is interpreted when it goes upstream and
|
|
|
|
* downstream respectively.
|
|
|
|
*
|
2008-09-02 16:12:56 +02:00
|
|
|
* <h3>The context object</h3>
|
2008-09-02 14:04:04 +02:00
|
|
|
* <p>
|
|
|
|
* A {@link ChannelHandler} is provided with a {@link ChannelHandlerContext}
|
|
|
|
* object. The {@link ChannelHandler} is supposed to interact with the
|
|
|
|
* {@link ChannelPipeline} it belongs to via the context object. Using the
|
|
|
|
* context object, the {@link ChannelHandler} can fire events to the next
|
|
|
|
* or previous handler or modify the behavior of the pipeline by adding or
|
|
|
|
* removing a handler for example.
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
2008-09-02 16:12:56 +02:00
|
|
|
* <h3>Additional resources worth reading</h3>
|
|
|
|
* <p>
|
|
|
|
* Please refer to the {@link ChannelEvent} documentation to find out what a
|
|
|
|
* upstream event and a downstream event are and what fundamental differences
|
|
|
|
* they have, if you didn't read yet.
|
|
|
|
*
|
2008-08-08 03:27:24 +02:00
|
|
|
* @author The Netty Project (netty-dev@lists.jboss.org)
|
|
|
|
* @author Trustin Lee (tlee@redhat.com)
|
2008-08-08 02:37:18 +02:00
|
|
|
*
|
|
|
|
* @version $Rev$, $Date$
|
|
|
|
*/
|
|
|
|
public interface ChannelHandler {
|
2008-08-27 14:22:06 +02:00
|
|
|
// This is a tag interface.
|
2008-08-08 02:37:18 +02:00
|
|
|
}
|