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
21 /**
22 * A {@link ChannelEvent} that is triggered when a {@link Channel} has been idle
23 * for a while.
24 *
25 * @author <a href="http://www.jboss.org/netty/">The Netty Project</a>
26 * @author <a href="http://gleamynode.net/">Trustin Lee</a>
27 * @version $Rev: 2080 $, $Date: 2010-01-26 18:04:19 +0900 (Tue, 26 Jan 2010) $
28 *
29 * @apiviz.landmark
30 * @apiviz.has org.jboss.netty.handler.timeout.IdleState oneway - -
31 */
32 public interface IdleStateEvent extends ChannelEvent {
33 /**
34 * Returns the detailed idle state.
35 */
36 IdleState getState();
37
38 /**
39 * Returns the last time when I/O occurred in milliseconds.
40 */
41 long getLastActivityTimeMillis();
42 }