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 /**
20 * Receives and processes the terminal downstream {@link ChannelEvent}s.
21 * <p>
22 * A {@link ChannelSink} is an internal component which is supposed to be
23 * implemented by a transport provider. Most users will not see this type
24 * in their code.
25 *
26 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
27 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
28 *
29 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
30 *
31 * @apiviz.uses org.jboss.netty.channel.ChannelPipeline - - sends events upstream
32 */
33 public interface ChannelSink {
34
35 /**
36 * Invoked by {@link ChannelPipeline} when a downstream {@link ChannelEvent}
37 * has reached its terminal (the head of the pipeline).
38 */
39 void eventSunk(ChannelPipeline pipeline, ChannelEvent e) throws Exception;
40
41 /**
42 * Invoked by {@link ChannelPipeline} when an exception was raised while
43 * one of its {@link ChannelHandler}s process a {@link ChannelEvent}.
44 */
45 void exceptionCaught(ChannelPipeline pipeline, ChannelEvent e, ChannelPipelineException cause) throws Exception;
46 }