Class CompleteChannelFuture

java.lang.Object

io.netty.util.concurrent.AbstractFuture<Void>

io.netty.util.concurrent.CompleteFuture<Void>

io.netty.channel.CompleteChannelFuture

All Implemented Interfaces:

ChannelFuture, Future<Void>, Future<Void>

Direct Known Subclasses:

FailedChannelFuture, SucceededChannelFuture

abstract class CompleteChannelFuture
extends CompleteFuture<Void>
implements ChannelFuture

A skeletal ChannelFuture implementation which represents a ChannelFuture which has been completed already.

Field Summary

Fields

Modifier and Type	Field	Description
private final Channel	channel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CompleteChannelFuture(Channel channel, EventExecutor executor)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
ChannelFuture	addListener(GenericFutureListener<? extends Future<? super Void>> listener)	Adds the specified listener to this future.
ChannelFuture	addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Adds the specified listeners to this future.
ChannelFuture	await()	Waits for this future to be completed.
ChannelFuture	awaitUninterruptibly()	Waits for this future to be completed without interruption.
Channel	channel()	Returns a channel where the I/O operation associated with this future takes place.
protected EventExecutor	executor()	Return the EventExecutor which is used by this CompleteFuture.
Void	getNow()	Return the result without blocking.
boolean	isVoid()	Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods: ChannelFuture.addListener(GenericFutureListener) ChannelFuture.addListeners(GenericFutureListener[]) ChannelFuture.await() Future.await(long, TimeUnit) ()} Future.await(long) ()} ChannelFuture.awaitUninterruptibly() ChannelFuture.sync() ChannelFuture.syncUninterruptibly()
ChannelFuture	removeListener(GenericFutureListener<? extends Future<? super Void>> listener)	Removes the first occurrence of the specified listener from this future.
ChannelFuture	removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Removes the first occurrence for each of the listeners from this future.
ChannelFuture	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelFuture	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from class CompleteFuture

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, isCancellable, isCancelled, isDone

Methods inherited from class AbstractFuture

get, get

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, cause, isCancellable, isSuccess

Methods inherited from interface Future

get, get, isCancelled, isDone

Field Details

channel

private final Channel channel

Constructor Details

CompleteChannelFuture

protected CompleteChannelFuture(Channel channel,
 EventExecutor executor)

Creates a new instance.

Parameters:

channel - the Channel associated with this future

Method Details

executor

protected EventExecutor executor()

Description copied from class: CompleteFuture

Return the EventExecutor which is used by this CompleteFuture.

Overrides:

executor in class CompleteFuture<Void>

addListener

public ChannelFuture addListener(GenericFutureListener<? extends Future<? super Void>> listener)

Description copied from interface: Future

Adds the specified listener to this future. The specified listener is notified when this future is done. If this future is already completed, the specified listener is notified immediately.

Specified by:

addListener in interface ChannelFuture

Specified by:

addListener in interface Future<Void>

Overrides:

addListener in class CompleteFuture<Void>

addListeners

public ChannelFuture addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Description copied from interface: Future

Adds the specified listeners to this future. The specified listeners are notified when this future is done. If this future is already completed, the specified listeners are notified immediately.

Specified by:

addListeners in interface ChannelFuture

Specified by:

addListeners in interface Future<Void>

Overrides:

addListeners in class CompleteFuture<Void>

removeListener

public ChannelFuture removeListener(GenericFutureListener<? extends Future<? super Void>> listener)

Description copied from interface: Future

Removes the first occurrence of the specified listener from this future. The specified listener is no longer notified when this future is done. If the specified listener is not associated with this future, this method does nothing and returns silently.

Specified by:

removeListener in interface ChannelFuture

Specified by:

removeListener in interface Future<Void>

Overrides:

removeListener in class CompleteFuture<Void>

removeListeners

public ChannelFuture removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)

Description copied from interface: Future

Removes the first occurrence for each of the listeners from this future. The specified listeners are no longer notified when this future is done. If the specified listeners are not associated with this future, this method does nothing and returns silently.

Specified by:

removeListeners in interface ChannelFuture

Specified by:

removeListeners in interface Future<Void>

Overrides:

removeListeners in class CompleteFuture<Void>

syncUninterruptibly

public ChannelFuture syncUninterruptibly()

Description copied from interface: Future

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

syncUninterruptibly in interface ChannelFuture

Specified by:

syncUninterruptibly in interface Future<Void>

Overrides:

syncUninterruptibly in class CompleteFuture<Void>

sync

public ChannelFuture sync()
                   throws InterruptedException

Description copied from interface: Future

Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Specified by:

sync in interface ChannelFuture

Specified by:

sync in interface Future<Void>

Overrides:

sync in class CompleteFuture<Void>

Throws:

InterruptedException

await

public ChannelFuture await()
                    throws InterruptedException

Description copied from interface: Future

Waits for this future to be completed.

Specified by:

await in interface ChannelFuture

Specified by:

await in interface Future<Void>

Overrides:

await in class CompleteFuture<Void>

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

public ChannelFuture awaitUninterruptibly()

Description copied from interface: Future

Waits for this future to be completed without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface ChannelFuture

Specified by:

awaitUninterruptibly in interface Future<Void>

Overrides:

awaitUninterruptibly in class CompleteFuture<Void>

channel

public Channel channel()

Description copied from interface: ChannelFuture

Returns a channel where the I/O operation associated with this future takes place.

Specified by:

channel in interface ChannelFuture

getNow

public Void getNow()

Description copied from interface: Future

Return the result without blocking. If the future is not done yet this will return null.

As it is possible that a null value is used to mark the future as successful you also need to check if the future is really done with Future.isDone() and not rely on the returned null value.

Specified by:

getNow in interface Future<Void>

isVoid

public boolean isVoid()

Description copied from interface: ChannelFuture

Returns true if this ChannelFuture is a void future and so not allow to call any of the following methods:

• ChannelFuture.addListener(GenericFutureListener)
• ChannelFuture.addListeners(GenericFutureListener[])
• ChannelFuture.await()
• Future.await(long, TimeUnit) ()}
• Future.await(long) ()}
• ChannelFuture.awaitUninterruptibly()
• ChannelFuture.sync()
• ChannelFuture.syncUninterruptibly()

Specified by:

isVoid in interface ChannelFuture