## Uses of Class
org.apache.mina.core.session.IdleStatus

- Packages that use IdleStatus
  Package | Description
  --- | ---
  org.apache.mina.core.filterchain |
  org.apache.mina.core.service |
  org.apache.mina.core.session |
  org.apache.mina.example.echoserver | Echo server which demonstates low-level I/O layer and SSL support.
  org.apache.mina.example.gettingstarted.timeserver |
  org.apache.mina.example.netcat | NetCat client (Network + Unix `cat` command) which demonstates low-level I/O layer.
  org.apache.mina.example.sumup | SumUp Server and Client which sums up all ADD requests.
  org.apache.mina.example.tcp.perf |
  org.apache.mina.example.udp |
  org.apache.mina.example.udp.client |
  org.apache.mina.example.udp.perf |
  org.apache.mina.filter.executor | `IoFilter`s that provide flexible thread model and event queue monitoring interface.
  org.apache.mina.filter.firewall | Classes that implement `IoFilter` and provide host blocking and throttling.
  org.apache.mina.filter.keepalive | `IoFilter` that provides the ability for connections to remain open when data is not being transferred.
  org.apache.mina.filter.logging | Classes that implement `IoFilter` and provide logging of the events and data that flows through a MINA-based system.
  org.apache.mina.filter.statistic | Classes that implement `IoFilter` and provide the ability for filters to be timed on their performance.
  org.apache.mina.filter.util | Utility classes for the MINA filtering portion of the library.
  org.apache.mina.handler.multiton | Enables creating a handler per session instead of having one handler for many sessions, using Multiton pattern.
  org.apache.mina.handler.stream |
  org.apache.mina.proxy.event |
  org.apache.mina.proxy.filter |

- - ### Uses of IdleStatus in org.apache.mina.core.filterchain

    Methods in org.apache.mina.core.filterchain with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | IoFilterChain.`fireSessionIdle(IdleStatus status)` Fires a `IoHandler.sessionIdle(IoSession, IdleStatus)` event.
    `void` | DefaultIoFilterChain.`fireSessionIdle(IdleStatus status)`
    `void` | IoFilterAdapter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Filters `IoHandler.sessionIdle(IoSession,IdleStatus)` event.
    `void` | IoFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Filters `IoHandler.sessionIdle(IoSession,IdleStatus)` event.
    `void` | IoFilter.NextFilter.`sessionIdle(IoSession session, IdleStatus status)` Forwards `sessionIdle` event to next filter.

  - ### Uses of IdleStatus in org.apache.mina.core.service

    Methods in org.apache.mina.core.service with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | IoServiceListener.`serviceIdle(IoService service, IdleStatus idleStatus)` Invoked when a service is idle.
    `void` | IoHandlerAdapter.`sessionIdle(IoSession session, IdleStatus status)`
    `void` | IoHandler.`sessionIdle(IoSession session, IdleStatus status)` Invoked with the related `IdleStatus` when a connection becomes idle.

  - ### Uses of IdleStatus in org.apache.mina.core.session

    Fields in org.apache.mina.core.session declared as IdleStatus
    Modifier and Type | Field and Description
    --- | ---
    `static IdleStatus` | IdleStatus.`BOTH_IDLE` Represents both `READER_IDLE` and `WRITER_IDLE`.
    `static IdleStatus` | IdleStatus.`READER_IDLE` Represents the session status that no data is coming from the remote peer.
    `static IdleStatus` | IdleStatus.`WRITER_IDLE` Represents the session status that the session is not writing any data.

    Methods in org.apache.mina.core.session with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `int` | IoSession.`getIdleCount(IdleStatus status)` Returns the number of the fired continuous `sessionIdle` events for the specified `IdleStatus`.
    `int` | AbstractIoSession.`getIdleCount(IdleStatus status)` Returns the number of the fired continuous `sessionIdle` events for the specified `IdleStatus`.
    `int` | IoSessionConfig.`getIdleTime(IdleStatus status)` Returns idle time for the specified type of idleness in seconds.
    `int` | AbstractIoSessionConfig.`getIdleTime(IdleStatus status)` Returns idle time for the specified type of idleness in seconds.
    `long` | IoSessionConfig.`getIdleTimeInMillis(IdleStatus status)` Returns idle time for the specified type of idleness in milliseconds.
    `long` | AbstractIoSessionConfig.`getIdleTimeInMillis(IdleStatus status)` Returns idle time for the specified type of idleness in milliseconds.
    `long` | IoSession.`getLastIdleTime(IdleStatus status)` Returns the time in milliseconds when the last `sessionIdle` event is fired for the specified `IdleStatus`.
    `long` | AbstractIoSession.`getLastIdleTime(IdleStatus status)` Returns the time in milliseconds when the last `sessionIdle` event is fired for the specified `IdleStatus`.
    `void` | AbstractIoSession.`increaseIdleCount(IdleStatus status, long currentTime)` TODO Add method documentation
    `boolean` | IoSession.`isIdle(IdleStatus status)` Returns `true` if this session is idle for the specified `IdleStatus`.
    `boolean` | AbstractIoSession.`isIdle(IdleStatus status)` Returns `true` if this session is idle for the specified `IdleStatus`.
    `void` | IoSessionConfig.`setIdleTime(IdleStatus status, int idleTime)` Sets idle time for the specified type of idleness in seconds.
    `void` | AbstractIoSessionConfig.`setIdleTime(IdleStatus status, int idleTime)` Sets idle time for the specified type of idleness in seconds.

  - ### Uses of IdleStatus in org.apache.mina.example.echoserver

    Methods in org.apache.mina.example.echoserver with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | EchoProtocolHandler.`sessionIdle(IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.example.gettingstarted.timeserver

    Methods in org.apache.mina.example.gettingstarted.timeserver with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | TimeServerHandler.`sessionIdle(IoSession session, IdleStatus status)` On idle, we just write a message on the console

  - ### Uses of IdleStatus in org.apache.mina.example.netcat

    Methods in org.apache.mina.example.netcat with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | NetCatProtocolHandler.`sessionIdle(IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.example.sumup

    Methods in org.apache.mina.example.sumup with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | ServerSessionHandler.`sessionIdle(IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.example.tcp.perf

    Methods in org.apache.mina.example.tcp.perf with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | TcpServer.`sessionIdle(IoSession session, IdleStatus status)` Invoked with the related `IdleStatus` when a connection becomes idle.
    `void` | TcpClient.`sessionIdle(IoSession session, IdleStatus status)` Invoked with the related `IdleStatus` when a connection becomes idle.

  - ### Uses of IdleStatus in org.apache.mina.example.udp

    Methods in org.apache.mina.example.udp with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | MemoryMonitorHandler.`sessionIdle(IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.example.udp.client

    Methods in org.apache.mina.example.udp.client with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | MemMonClient.`sessionIdle(IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.example.udp.perf

    Methods in org.apache.mina.example.udp.perf with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | UdpServer.`sessionIdle(IoSession session, IdleStatus status)` Invoked with the related `IdleStatus` when a connection becomes idle.
    `void` | UdpClient.`sessionIdle(IoSession session, IdleStatus status)` Invoked with the related `IdleStatus` when a connection becomes idle.

  - ### Uses of IdleStatus in org.apache.mina.filter.executor

    Methods in org.apache.mina.filter.executor with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | ExecutorFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Filters `IoHandler.sessionIdle(IoSession,IdleStatus)` event.

  - ### Uses of IdleStatus in org.apache.mina.filter.firewall

    Methods in org.apache.mina.filter.firewall with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | BlacklistFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.filter.keepalive

    Methods in org.apache.mina.filter.keepalive that return IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `IdleStatus` | KeepAliveFilter.`getInterestedIdleStatus()`

    Methods in org.apache.mina.filter.keepalive with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | KeepAliveFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)`

    Constructors in org.apache.mina.filter.keepalive with parameters of type IdleStatus
    Constructor and Description
    `KeepAliveFilter(KeepAliveMessageFactory messageFactory, IdleStatus interestedIdleStatus)` Creates a new instance with the default properties.
    `KeepAliveFilter(KeepAliveMessageFactory messageFactory, IdleStatus interestedIdleStatus, KeepAliveRequestTimeoutHandler policy)` Creates a new instance with the default properties.
    `KeepAliveFilter(KeepAliveMessageFactory messageFactory, IdleStatus interestedIdleStatus, KeepAliveRequestTimeoutHandler policy, int keepAliveRequestInterval, int keepAliveRequestTimeout)` Creates a new instance.

  - ### Uses of IdleStatus in org.apache.mina.filter.logging

    Methods in org.apache.mina.filter.logging with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | LoggingFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.filter.statistic

    Methods in org.apache.mina.filter.statistic with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | ProfilerTimerFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Profile a SessionIdle event.

  - ### Uses of IdleStatus in org.apache.mina.filter.util

    Methods in org.apache.mina.filter.util with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | ReferenceCountingFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)`
    `void` | CommonEventFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)`

  - ### Uses of IdleStatus in org.apache.mina.handler.multiton

    Methods in org.apache.mina.handler.multiton with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | SingleSessionIoHandlerAdapter.`sessionIdle(IdleStatus status)` Deprecated.
    `void` | SingleSessionIoHandler.`sessionIdle(IdleStatus status)` Deprecated. Invoked when the connection is idle.
    `void` | SingleSessionIoHandlerDelegate.`sessionIdle(IoSession session, IdleStatus status)` Deprecated. Delegates the method call to the `SingleSessionIoHandler.sessionIdle(IdleStatus)` method of the handler assigned to this session.

  - ### Uses of IdleStatus in org.apache.mina.handler.stream

    Methods in org.apache.mina.handler.stream with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | StreamIoHandler.`sessionIdle(IoSession session, IdleStatus status)` Handles read timeout.

  - ### Uses of IdleStatus in org.apache.mina.proxy.event

    Methods in org.apache.mina.proxy.event that return IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `IdleStatus` | IoSessionEvent.`getStatus()` Returns the idle status of the event.

    Constructors in org.apache.mina.proxy.event with parameters of type IdleStatus
    Constructor and Description
    `IoSessionEvent(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Creates an instance of this class when event type is `IoSessionEventType.IDLE`.

  - ### Uses of IdleStatus in org.apache.mina.proxy.filter

    Methods in org.apache.mina.proxy.filter with parameters of type IdleStatus
    Modifier and Type | Method and Description
    --- | ---
    `void` | ProxyFilter.`sessionIdle(IoFilter.NextFilter nextFilter, IoSession session, IdleStatus status)` Event is stored in an `IoSessionEventQueue` for later delivery to the next filter in the chain when the handshake would have succeed.

Copyright © 2004-2012 Apache MINA Project. All Rights Reserved.