Package io.netty.channel.group

Class VoidChannelGroupFuture

java.lang.Object

io.netty.channel.group.VoidChannelGroupFuture

All Implemented Interfaces:

ChannelGroupFuture, Future<Void>, Iterable<ChannelFuture>, Future<Void>

final class VoidChannelGroupFuture
extends Object
implements ChannelGroupFuture

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.concurrent.Future

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
private static final Iterator<ChannelFuture>	EMPTY
private final ChannelGroup	group

Constructor Summary

Constructors

Constructor	Description
VoidChannelGroupFuture(ChannelGroup group)

Method Summary

Modifier and Type	Method	Description
ChannelGroupFuture	addListener(GenericFutureListener<? extends Future<? super Void>> listener)	Adds the specified listener to this future.
ChannelGroupFuture	addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Adds the specified listeners to this future.
ChannelGroupFuture	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, TimeUnit unit)	Waits for this future to be completed within the specified time limit.
ChannelGroupFuture	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, TimeUnit unit)	Waits for this future to be completed within the specified time limit without interruption.
boolean	cancel(boolean mayInterruptIfRunning)	If the cancellation was successful it will fail the future with a CancellationException.
ChannelGroupException	cause()	Returns the cause of the failed I/O operation if the I/O operation has failed.
ChannelFuture	find(Channel channel)	Returns the ChannelFuture of the individual I/O operation which is associated with the specified Channel.
Void	get()
Void	get(long timeout, TimeUnit unit)
Void	getNow()	Return the result without blocking.
ChannelGroup	group()	Returns the ChannelGroup which is associated with this future.
boolean	isCancellable()	returns true if and only if the operation can be cancelled via Future.cancel(boolean).
boolean	isCancelled()
boolean	isDone()
boolean	isPartialFailure()	Returns true if and only if the I/O operations associated with this future have failed partially with some success.
boolean	isPartialSuccess()	Returns true if and only if the I/O operations associated with this future were partially successful with some failure.
boolean	isSuccess()	Returns true if and only if all I/O operations associated with this future were successful without any failure.
Iterator<ChannelFuture>	iterator()	Returns the Iterator that enumerates all ChannelFutures which are associated with this future.
private static RuntimeException	reject()
ChannelGroupFuture	removeListener(GenericFutureListener<? extends Future<? super Void>> listener)	Removes the first occurrence of the specified listener from this future.
ChannelGroupFuture	removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Removes the first occurrence for each of the listeners from this future.
ChannelGroupFuture	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
ChannelGroupFuture	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.concurrent.Future

exceptionNow, resultNow, state

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

EMPTY

private static final Iterator<ChannelFuture> EMPTY

group

private final ChannelGroup group

Constructor Details

VoidChannelGroupFuture

VoidChannelGroupFuture(ChannelGroup group)

Method Details

group

public ChannelGroup group()

Description copied from interface: ChannelGroupFuture

Returns the ChannelGroup which is associated with this future.

Specified by:

group in interface ChannelGroupFuture

find

public ChannelFuture find(Channel channel)

Description copied from interface: ChannelGroupFuture

Returns the ChannelFuture of the individual I/O operation which is associated with the specified Channel.

Specified by:

find in interface ChannelGroupFuture

Returns:

the matching ChannelFuture if found. null otherwise.

isSuccess

public boolean isSuccess()

Description copied from interface: ChannelGroupFuture

Returns true if and only if all I/O operations associated with this future were successful without any failure.

Specified by:

isSuccess in interface ChannelGroupFuture

Specified by:

isSuccess in interface Future<Void>

cause

public ChannelGroupException cause()

Description copied from interface: Future

Returns the cause of the failed I/O operation if the I/O operation has failed.

Specified by:

cause in interface ChannelGroupFuture

Specified by:

cause in interface Future<Void>

Returns:

the cause of the failure. null if succeeded or this future is not completed yet.

isPartialSuccess

public boolean isPartialSuccess()

Description copied from interface: ChannelGroupFuture

Returns true if and only if the I/O operations associated with this future were partially successful with some failure.

Specified by:

isPartialSuccess in interface ChannelGroupFuture

isPartialFailure

public boolean isPartialFailure()

Description copied from interface: ChannelGroupFuture

Returns true if and only if the I/O operations associated with this future have failed partially with some success.

Specified by:

isPartialFailure in interface ChannelGroupFuture

addListener

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

addListener in interface Future<Void>

addListeners

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

addListeners in interface Future<Void>

removeListener

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

removeListener in interface Future<Void>

removeListeners

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

removeListeners in interface Future<Void>

await

public ChannelGroupFuture await()

Description copied from interface: Future

Waits for this future to be completed.

Specified by:

await in interface ChannelGroupFuture

Specified by:

await in interface Future<Void>

awaitUninterruptibly

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

awaitUninterruptibly in interface Future<Void>

syncUninterruptibly

public ChannelGroupFuture 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 ChannelGroupFuture

Specified by:

syncUninterruptibly in interface Future<Void>

sync

public ChannelGroupFuture sync()

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 ChannelGroupFuture

Specified by:

sync in interface Future<Void>

iterator

public Iterator<ChannelFuture> iterator()

Description copied from interface: ChannelGroupFuture

Returns the Iterator that enumerates all ChannelFutures which are associated with this future. Please note that the returned Iterator is unmodifiable, which means a ChannelFuture cannot be removed from this future.

Specified by:

iterator in interface ChannelGroupFuture

Specified by:

iterator in interface Iterable<ChannelFuture>

isCancellable

public boolean isCancellable()

Description copied from interface: Future

returns true if and only if the operation can be cancelled via Future.cancel(boolean).

Specified by:

isCancellable in interface Future<Void>

await

public boolean await(long timeout,
 TimeUnit unit)

Description copied from interface: Future

Waits for this future to be completed within the specified time limit.

Specified by:

await in interface Future<Void>

Returns:

true if and only if the future was completed within the specified time limit

await

public boolean await(long timeoutMillis)

Description copied from interface: Future

Waits for this future to be completed within the specified time limit.

Specified by:

await in interface Future<Void>

Returns:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeout,
 TimeUnit unit)

Description copied from interface: Future

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface Future<Void>

Returns:

true if and only if the future was completed within the specified time limit

awaitUninterruptibly

public boolean awaitUninterruptibly(long timeoutMillis)

Description copied from interface: Future

Waits for this future to be completed within the specified time limit without interruption. This method catches an InterruptedException and discards it silently.

Specified by:

awaitUninterruptibly in interface Future<Void>

Returns:

true if and only if the future was completed within the specified time limit

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>

cancel

public boolean cancel(boolean mayInterruptIfRunning)

If the cancellation was successful it will fail the future with a CancellationException.

Specified by:

cancel in interface Future<Void>

Specified by:

cancel in interface Future<Void>

Parameters:

mayInterruptIfRunning - this value has no effect in this implementation.

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Future<Void>

isDone

public boolean isDone()

Specified by:

isDone in interface Future<Void>

get

public Void get()

Specified by:

get in interface Future<Void>

get

public Void get(long timeout,
 TimeUnit unit)

Specified by:

get in interface Future<Void>

reject

private static RuntimeException reject()