Package io.netty.channel.group

Class DefaultChannelGroupFuture

java.lang.Object

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

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

io.netty.channel.group.DefaultChannelGroupFuture

All Implemented Interfaces:

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

final class DefaultChannelGroupFuture
extends DefaultPromise<Void>
implements ChannelGroupFuture

The default ChannelGroupFuture implementation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	DefaultChannelGroupFuture.DefaultEntry<K,V>

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

Future.State

Field Summary

Fields

Modifier and Type	Field	Description
private final ChannelFutureListener	childListener
private int	failureCount
private final Map<Channel,ChannelFuture>	futures
private final ChannelGroup	group
private int	successCount

Fields inherited from class io.netty.util.concurrent.DefaultPromise

PROPERTY_MAX_LISTENER_STACK_DEPTH

Constructor Summary

Constructors

Constructor	Description
DefaultChannelGroupFuture(ChannelGroup group, Collection<ChannelFuture> futures, EventExecutor executor)	Creates a new instance.
DefaultChannelGroupFuture(ChannelGroup group, Map<Channel,ChannelFuture> futures, EventExecutor executor)

Method Summary

Modifier and Type	Method	Description
DefaultChannelGroupFuture	addListener(GenericFutureListener<? extends Future<? super Void>> listener)	Adds the specified listener to this future.
DefaultChannelGroupFuture	addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Adds the specified listeners to this future.
DefaultChannelGroupFuture	await()	Waits for this future to be completed.
DefaultChannelGroupFuture	awaitUninterruptibly()	Waits for this future to be completed without interruption.
ChannelGroupException	cause()	Returns the cause of the failed I/O operation if the I/O operation has failed.
protected void	checkDeadLock()
ChannelFuture	find(Channel channel)	Returns the ChannelFuture of the individual I/O operation which is associated with the specified Channel.
ChannelGroup	group()	Returns the ChannelGroup which is associated with this future.
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.
Iterator<ChannelFuture>	iterator()	Returns the Iterator that enumerates all ChannelFutures which are associated with this future.
DefaultChannelGroupFuture	removeListener(GenericFutureListener<? extends Future<? super Void>> listener)	Removes the first occurrence of the specified listener from this future.
DefaultChannelGroupFuture	removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners)	Removes the first occurrence for each of the listeners from this future.
DefaultChannelGroupFuture	setFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
private void	setFailure0(ChannelGroupException cause)
DefaultChannelGroupFuture	setSuccess(Void result)	Marks this future as a success and notifies all listeners.
private void	setSuccess0()
DefaultChannelGroupFuture	sync()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
DefaultChannelGroupFuture	syncUninterruptibly()	Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
boolean	tryFailure(Throwable cause)	Marks this future as a failure and notifies all listeners.
boolean	trySuccess(Void result)	Marks this future as a success and notifies all listeners.

Methods inherited from class io.netty.util.concurrent.DefaultPromise

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, executor, get, get, getNow, isCancellable, isCancelled, isDone, isSuccess, notifyListener, setUncancellable, toString, toStringBuilder

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.group.ChannelGroupFuture

isSuccess

Methods inherited from interface io.netty.util.concurrent.Future

await, await, awaitUninterruptibly, awaitUninterruptibly, cancel, getNow, isCancellable

Methods inherited from interface java.util.concurrent.Future

exceptionNow, get, get, isCancelled, isDone, resultNow, state

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Details

group

private final ChannelGroup group

futures

private final Map<Channel,ChannelFuture> futures

successCount

private int successCount

failureCount

private int failureCount

childListener

private final ChannelFutureListener childListener

Constructor Details

DefaultChannelGroupFuture

DefaultChannelGroupFuture(ChannelGroup group,
 Collection<ChannelFuture> futures,
 EventExecutor executor)

Creates a new instance.

DefaultChannelGroupFuture

DefaultChannelGroupFuture(ChannelGroup group,
 Map<Channel,ChannelFuture> futures,
 EventExecutor executor)

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.

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>

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 DefaultChannelGroupFuture 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>

Specified by:

addListener in interface Promise<Void>

Overrides:

addListener in class DefaultPromise<Void>

addListeners

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

Specified by:

addListeners in interface Promise<Void>

Overrides:

addListeners in class DefaultPromise<Void>

removeListener

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

Specified by:

removeListener in interface Promise<Void>

Overrides:

removeListener in class DefaultPromise<Void>

removeListeners

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

Specified by:

removeListeners in interface Promise<Void>

Overrides:

removeListeners in class DefaultPromise<Void>

await

public DefaultChannelGroupFuture await()
                                throws InterruptedException

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>

Specified by:

await in interface Promise<Void>

Overrides:

await in class DefaultPromise<Void>

Throws:

InterruptedException - if the current thread was interrupted

awaitUninterruptibly

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

Specified by:

awaitUninterruptibly in interface Promise<Void>

Overrides:

awaitUninterruptibly in class DefaultPromise<Void>

syncUninterruptibly

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

Specified by:

syncUninterruptibly in interface Promise<Void>

Overrides:

syncUninterruptibly in class DefaultPromise<Void>

sync

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

Specified by:

sync in interface Future<Void>

Specified by:

sync in interface Promise<Void>

Overrides:

sync in class DefaultPromise<Void>

Throws:

InterruptedException

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>

Overrides:

cause in class DefaultPromise<Void>

Returns:

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

setSuccess0

private void setSuccess0()

setFailure0

private void setFailure0(ChannelGroupException cause)

setSuccess

public DefaultChannelGroupFuture setSuccess(Void result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Specified by:

setSuccess in interface Promise<Void>

Overrides:

setSuccess in class DefaultPromise<Void>

trySuccess

public boolean trySuccess(Void result)

Description copied from interface: Promise

Marks this future as a success and notifies all listeners.

Specified by:

trySuccess in interface Promise<Void>

Overrides:

trySuccess in class DefaultPromise<Void>

Returns:

true if and only if successfully marked this future as a success. Otherwise false because this future is already marked as either a success or a failure.

setFailure

public DefaultChannelGroupFuture setFailure(Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners. If it is success or failed already it will throw an IllegalStateException.

Specified by:

setFailure in interface Promise<Void>

Overrides:

setFailure in class DefaultPromise<Void>

tryFailure

public boolean tryFailure(Throwable cause)

Description copied from interface: Promise

Marks this future as a failure and notifies all listeners.

Specified by:

tryFailure in interface Promise<Void>

Overrides:

tryFailure in class DefaultPromise<Void>

Returns:

true if and only if successfully marked this future as a failure. Otherwise false because this future is already marked as either a success or a failure.

checkDeadLock

protected void checkDeadLock()

Overrides:

checkDeadLock in class DefaultPromise<Void>