## Uses of Interface
org.apache.mina.api.IoFuture

- Packages that use IoFuture
  Package | Description
  --- | ---
  org.apache.mina.api | Base API for the MINA library.
  org.apache.mina.filter.query |
  org.apache.mina.session |
  org.apache.mina.transport |
  org.apache.mina.transport.bio | Transport implementation base on blocking I/O `Socket`
  org.apache.mina.transport.nio | Transport implementations base on NIO (New I/O), `Channel`
  org.apache.mina.transport.udp | Shared plumber UDP transport implementations.
  org.apache.mina.util | Various utilities.

- - ### Uses of IoFuture in org.apache.mina.api

    Methods in org.apache.mina.api that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<Void>` | IoSession.`close(boolean immediately)` Closes this session immediately or after all queued write requests are flushed.
    `IoFuture<IoSession>` | IoClient.`connect(SocketAddress remoteAddress)` Connects to the specified remote address.
    `IoFuture<V>` | IoFuture.`register(IoFutureListener<V> listener)` Register a listener to asynchronously receive the results of the future computation.
    `IoFuture<Void>` | IoSession.`writeWithFuture(Object message)` Same as `IoSession.write(Object)`, but provide a `IoFuture` for tracking the completion of this write.

  - ### Uses of IoFuture in org.apache.mina.filter.query

    Methods in org.apache.mina.filter.query that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<RESPONSE>` | RequestFilter.`request(IoSession session, REQUEST request, long timeoutInMs)` Send a request message and provide a `IoFuture` for handling the response.

  - ### Uses of IoFuture in org.apache.mina.session

    Classes in org.apache.mina.session that implement IoFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultWriteFuture` The default implementation for the `IoFuture` returned by `IoSession.writeWithFuture(Object)`

    Methods in org.apache.mina.session that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<Void>` | WriteRequest.`getFuture()` The future to be completed on a write success
    `IoFuture<Void>` | DefaultWriteRequest.`getFuture()` The future to be completed on a write success
    `IoFuture<Void>` | AbstractIoSession.`writeWithFuture(Object message)` Same as `IoSession.write(Object)`, but provide a `IoFuture` for tracking the completion of this write.

    Methods in org.apache.mina.session with parameters of type IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `void` | AbstractIoSession.`processMessageWriting(WriteRequest writeRequest, IoFuture<Void> future)` process session message writing event using the filter chain.
    `void` | WriteRequest.`setFuture(IoFuture<Void> future)` Store the future into the request
    `void` | DefaultWriteRequest.`setFuture(IoFuture<Void> future)` Store the future into the request

  - ### Uses of IoFuture in org.apache.mina.transport

    Classes in org.apache.mina.transport that implement IoFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `ConnectFuture` `Future` for waiting session connection.

  - ### Uses of IoFuture in org.apache.mina.transport.bio

    Methods in org.apache.mina.transport.bio that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<Void>` | BioUdpSession.`close(boolean immediately)` Closes this session immediately or after all queued write requests are flushed.
    `IoFuture<IoSession>` | BioUdpServer.`connect(SocketAddress remoteAddress)`

  - ### Uses of IoFuture in org.apache.mina.transport.nio

    Methods in org.apache.mina.transport.nio that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<Void>` | AbstractNioSession.`close(boolean immediately)` Closes this session immediately or after all queued write requests are flushed.
    `IoFuture<IoSession>` | NioUdpServer.`connect(SocketAddress remoteAddress)`
    `IoFuture<IoSession>` | NioUdpClient.`connect(SocketAddress remoteAddress)` Connects to the specified remote address.
    `IoFuture<IoSession>` | NioTcpClient.`connect(SocketAddress remoteAddress)` Connects to the specified remote address.
    `IoFuture<IoSession>` | NioUdpClient.`connect(SocketAddress remoteAddress, SocketAddress localAddress)` Connects to the specified remote address binding to the specified local address.

  - ### Uses of IoFuture in org.apache.mina.transport.udp

    Methods in org.apache.mina.transport.udp that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `abstract IoFuture<IoSession>` | AbstractUdpClient.`connect(SocketAddress remoteAddress, SocketAddress localAddress)` Connects to the specified remote address binding to the specified local address.

  - ### Uses of IoFuture in org.apache.mina.util

    Classes in org.apache.mina.util that implement IoFuture
    Modifier and Type | Class and Description
    --- | ---
    `class` | `AbstractIoFuture<V>` An abstract implementation of `IoFuture`.

    Methods in org.apache.mina.util that return IoFuture
    Modifier and Type | Method and Description
    --- | ---
    `IoFuture<V>` | AbstractIoFuture.`register(IoFutureListener<V> listener)` Register a listener to asynchronously receive the results of the future computation.

Copyright © 2009–2013 Apache MINA Project. All rights reserved.