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.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   * @apiviz.landmark
    25   * @apiviz.has org.jboss.netty.handler.timeout.IdleState oneway - -
    26   */
    27  public interface IdleStateEvent extends ChannelEvent {
    28      /**
    29       * Returns the detailed idle state.
    30       */
    31      IdleState getState();
    32
    33      /**
    34       * Returns the last time when I/O occurred in milliseconds.
    35       */
    36      long getLastActivityTimeMillis();
    37  }