DefaultChannelFuture (The Netty Project API Reference (3.2.3.Final, r-1))

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.jboss.netty.channel
Class DefaultChannelFuture

java.lang.Object
  org.jboss.netty.channel.DefaultChannelFuture

All Implemented Interfaces:: ChannelFuture

public class DefaultChannelFuture
extends java.lang.Object
implements ChannelFuture
extends java.lang.Object
implements ChannelFuture

The default ChannelFuture implementation. It is recommended to use Channels.future(Channel) and Channels.future(Channel, boolean) to create a new ChannelFuture rather than calling the constructor explicitly.

Version:: $Rev: 2201 $, $Date: 2010-02-23 14:45:53 +0900 (Tue, 23 Feb 2010) $
Author:: The Netty Project, Trustin Lee

Constructor Summary
`DefaultChannelFuture(Channel channel, boolean cancellable)` Creates a new instance.

Method Summary
`void`	`addListener(ChannelFutureListener listener)` Adds the specified listener to this future.
`ChannelFuture`	`await()` Waits for this future to be completed.
`boolean`	`await(long timeoutMillis)` Waits for this future to be completed within the specified time limit.
`boolean`	`await(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit.
`ChannelFuture`	`awaitUninterruptibly()` Waits for this future to be completed without interruption.
`boolean`	`awaitUninterruptibly(long timeoutMillis)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`awaitUninterruptibly(long timeout, java.util.concurrent.TimeUnit unit)` Waits for this future to be completed within the specified time limit without interruption.
`boolean`	`cancel()` Cancels the I/O operation associated with this future and notifies all listeners if canceled successfully.
`java.lang.Throwable`	`getCause()` Returns the cause of the failed I/O operation if the I/O operation has failed.
`Channel`	`getChannel()` Returns a channel where the I/O operation associated with this future takes place.
`boolean`	`isCancelled()` Returns `true` if and only if this future was cancelled by a `ChannelFuture.cancel()` method.
`boolean`	`isDone()` Returns `true` if and only if this future is complete, regardless of whether the operation was successful, failed, or cancelled.
`boolean`	`isSuccess()` Returns `true` if and only if the I/O operation was completed successfully.
`static boolean`	`isUseDeadLockChecker()` Returns `true` if and only if the dead lock checker is enabled.
`void`	`removeListener(ChannelFutureListener listener)` Removes the specified listener from this future.
`boolean`	`setFailure(java.lang.Throwable cause)` Marks this future as a failure and notifies all listeners.
`boolean`	`setProgress(long amount, long current, long total)` Notifies the progress of the operation to the listeners that implements `ChannelFutureProgressListener`.
`boolean`	`setSuccess()` Marks this future as a success and notifies all listeners.
`static void`	`setUseDeadLockChecker(boolean useDeadLockChecker)` Enables or disables the dead lock checker.

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

Constructor Detail

DefaultChannelFuture

public DefaultChannelFuture(Channel channel,
                            boolean cancellable)

Creates a new instance.

Parameters:: channel - the Channel associated with this future; cancellable - true if and only if this future can be canceled

Method Detail

isUseDeadLockChecker

public static boolean isUseDeadLockChecker()

Returns true if and only if the dead lock checker is enabled.

setUseDeadLockChecker

public static void setUseDeadLockChecker(boolean useDeadLockChecker)

Enables or disables the dead lock checker. It is not recommended to disable the dead lock checker. Disable it at your own risk!