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.handler.timeout;
17
18 import org.jboss.netty.channel.Channel;
19 import org.jboss.netty.channel.ChannelEvent;
20 import org.jboss.netty.channel.ChannelHandlerContext;
21 import org.jboss.netty.channel.SimpleChannelUpstreamHandler;
22
23 /**
24 * An extended {@link SimpleChannelUpstreamHandler} that adds the handler method
25 * for an {@link IdleStateEvent}.
26 *
27 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
28 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
29 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
30 *
31 * @apiviz.uses org.jboss.netty.handler.timeout.IdleStateEvent
32 */
33 public class IdleStateAwareChannelUpstreamHandler extends SimpleChannelUpstreamHandler {
34
35 /**
36 * Creates a new instance.
37 */
38 public IdleStateAwareChannelUpstreamHandler() {
39 super();
40 }
41
42 @Override
43 public void handleUpstream(ChannelHandlerContext ctx, ChannelEvent e)
44 throws Exception {
45 if (e instanceof IdleStateEvent) {
46 channelIdle(ctx, (IdleStateEvent) e);
47 } else {
48 super.handleUpstream(ctx, e);
49 }
50 }
51
52 /**
53 * Invoked when a {@link Channel} has been idle for a while.
54 */
55 public void channelIdle(ChannelHandlerContext ctx, IdleStateEvent e) throws Exception {
56 ctx.sendUpstream(e);
57 }
58 }