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  /**
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   * @apiviz.uses org.jboss.netty.channel.ChannelPipeline - - sends events upstream
27   */
28  public interface ChannelSink {
29  
30      /**
31       * Invoked by {@link ChannelPipeline} when a downstream {@link ChannelEvent}
32       * has reached its terminal (the head of the pipeline).
33       */
34      void eventSunk(ChannelPipeline pipeline, ChannelEvent e) throws Exception;
35  
36      /**
37       * Invoked by {@link ChannelPipeline} when an exception was raised while
38       * one of its {@link ChannelHandler}s process a {@link ChannelEvent}.
39       */
40      void exceptionCaught(ChannelPipeline pipeline, ChannelEvent e, ChannelPipelineException cause) throws Exception;
41  
42      /**
43       * Execute the given {@link Runnable} later in the io-thread.
44       * Some implementation may not support this and just execute it directly.
45       */
46      ChannelFuture execute(ChannelPipeline pipeline, Runnable task);
47  }