org.jboss.netty.handler.timeout
Class IdleStateAwareChannelHandler

java.lang.Object
  org.jboss.netty.channel.SimpleChannelHandler
      org.jboss.netty.handler.timeout.IdleStateAwareChannelHandler

All Implemented Interfaces:

ChannelDownstreamHandler, ChannelHandler, ChannelUpstreamHandler

public class IdleStateAwareChannelHandler
extends SimpleChannelHandler

An extended SimpleChannelHandler that adds the handler method for an IdleStateEvent.

Version:

$Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $

Author:

The Netty Project, Trustin Lee

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

IdleStateAwareChannelHandler()
Creates a new instance.

Method Summary

void	channelIdle(ChannelHandlerContext ctx, IdleStateEvent e) Invoked when a Channel has been idle for a while.
void	handleUpstream(ChannelHandlerContext ctx, ChannelEvent e) Handles the specified upstream event.

Methods inherited from class org.jboss.netty.channel.SimpleChannelHandler

bindRequested, channelBound, channelClosed, channelConnected, channelDisconnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, closeRequested, connectRequested, disconnectRequested, exceptionCaught, handleDownstream, messageReceived, setInterestOpsRequested, unbindRequested, writeComplete, writeRequested

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IdleStateAwareChannelHandler

public IdleStateAwareChannelHandler()

Creates a new instance.

Method Detail

handleUpstream

public void handleUpstream(ChannelHandlerContext ctx,
                           ChannelEvent e)
                    throws java.lang.Exception

Description copied from class: SimpleChannelHandler

Handles the specified upstream event. Down-casts the received upstream event into more meaningful sub-type event and calls an appropriate handler method with the down-casted event.

Specified by:

handleUpstream in interface ChannelUpstreamHandler

Overrides:

handleUpstream in class SimpleChannelHandler

Parameters:

ctx - the context object for this handler

e - the upstream event to process or intercept

Throws:

java.lang.Exception

channelIdle

public void channelIdle(ChannelHandlerContext ctx,
                        IdleStateEvent e)
                 throws java.lang.Exception

Invoked when a Channel has been idle for a while.

Throws:

java.lang.Exception