DefaultConnectFuture (Apache MINA 2.0.0-M3 API Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.mina.core.future
Class DefaultConnectFuture

java.lang.Object
  org.apache.mina.core.future.DefaultIoFuture
      org.apache.mina.core.future.DefaultConnectFuture

public class DefaultConnectFuture
extends DefaultIoFuture
implements ConnectFuture
extends DefaultIoFuture
implements ConnectFuture

A default implementation of ConnectFuture.

Version:: $Rev: 671827 $, $Date: 2008-06-26 10:49:48 +0200 (jeu, 26 jun 2008) $
Author:: The Apache MINA Project (dev@mina.apache.org)

Constructor Summary
`DefaultConnectFuture()` Creates a new instance.

Method Summary
`ConnectFuture`	`addListener(IoFutureListener<?> listener)` Adds an event `listener` which is notified when this future is completed.
`ConnectFuture`	`await()` Wait for the asynchronous operation to complete.
`ConnectFuture`	`awaitUninterruptibly()` Wait for the asynchronous operation to complete uninterruptibly.
`void`	`cancel()` Cancels the connection attempt and notifies all threads waiting for this future.
`Throwable`	`getException()` Returns the cause of the connection failure.
`IoSession`	`getSession()` Returns the `IoSession` which is associated with this future.
`boolean`	`isCanceled()` Returns `true` if the connect operation has been canceled by `ConnectFuture.cancel()` method.
`boolean`	`isConnected()` Returns `true` if the connect operation is finished successfully.
`static ConnectFuture`	`newFailedFuture(Throwable exception)` Returns a new `ConnectFuture` which is already marked as 'failed to connect'.
`ConnectFuture`	`removeListener(IoFutureListener<?> listener)` Removes an existing event `listener` so it won't be notified when the future is completed.
`void`	`setException(Throwable exception)` Sets the exception caught due to connection failure and notifies all threads waiting for this future.
`void`	`setSession(IoSession session)` Sets the newly connected session and notifies all threads waiting for this future.

Methods inherited from class org.apache.mina.core.future.DefaultIoFuture
`await, await, awaitUninterruptibly, awaitUninterruptibly, getValue, isDone, join, join, setValue`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Methods inherited from interface org.apache.mina.core.future.IoFuture
`await, await, awaitUninterruptibly, awaitUninterruptibly, isDone, join, join`

Constructor Detail

public DefaultConnectFuture()

Creates a new instance.

Method Detail

public static ConnectFuture newFailedFuture(Throwable exception)

Returns a new ConnectFuture which is already marked as 'failed to connect'.

public IoSession getSession()

Description copied from class: DefaultIoFuture

Returns the IoSession which is associated with this future.