Netty 4.1.107.Final · io.netty.channel.group.VoidChannelGroupFuture

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

Access	Constructor and Description
pack-priv	VoidChannelGroupFuture(ChannelGroup group)

Method Summary

Modifier and Type	Method and Description
public ChannelGroupFuture	addListener(GenericFutureListener<? extends Future<? super Void>> listener) Implements io.netty.channel.group.ChannelGroupFuture.addListener. Adds the specified listener to this future.
public ChannelGroupFuture	addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) Implements io.netty.channel.group.ChannelGroupFuture.addListeners. Adds the specified listeners to this future.
public ChannelGroupFuture	await() Implements io.netty.channel.group.ChannelGroupFuture.await. Waits for this future to be completed.
public boolean	await(long timeout, TimeUnit unit) Implements io.netty.util.concurrent.Future.await. Waits for this future to be completed within the specified time limit.
public boolean	await(long timeoutMillis) Implements io.netty.util.concurrent.Future.await. Waits for this future to be completed within the specified time limit.
public ChannelGroupFuture	awaitUninterruptibly() Implements io.netty.channel.group.ChannelGroupFuture.awaitUninterruptibly. Waits for this future to be completed without interruption.
public boolean	awaitUninterruptibly(long timeout, TimeUnit unit) Implements io.netty.util.concurrent.Future.awaitUninterruptibly. Waits for this future to be completed within the specified time limit without interruption.
public boolean	awaitUninterruptibly(long timeoutMillis) Implements io.netty.util.concurrent.Future.awaitUninterruptibly. Waits for this future to be completed within the specified time limit without interruption.
public boolean	cancel(boolean this value has no effect in this implementation. mayInterruptIfRunning) Implements io.netty.util.concurrent.Future.cancel. Attempts to cancel execution of this task.
public ChannelGroupException	cause() Implements io.netty.channel.group.ChannelGroupFuture.cause. Returns the cause of the failed I/O operation if the I/O operation has failed.
public ChannelFuture	find(Channel channel) Implements io.netty.channel.group.ChannelGroupFuture.find. Returns the `ChannelFuture` of the individual I/O operation which is associated with the specified `Channel`.
public Void	get() Implements java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result.
public Void	get(long the maximum time to wait timeout, TimeUnit the time unit of the timeout argument unit) Implements java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.
public Void	getNow() Implements io.netty.util.concurrent.Future.getNow. Return the result without blocking.
public ChannelGroup	group() Implements io.netty.channel.group.ChannelGroupFuture.group. Returns the `ChannelGroup` which is associated with this future.
public boolean	isCancellable() Implements io.netty.util.concurrent.Future.isCancellable. returns `true` if and only if the operation can be cancelled via `cancel(boolean)`.
public boolean	isCancelled() Implements java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally.
public boolean	isDone() Implements java.util.concurrent.Future.isDone. Returns `true` if this task completed.
public boolean	isPartialFailure() Implements io.netty.channel.group.ChannelGroupFuture.isPartialFailure. Returns `true` if and only if the I/O operations associated with this future have failed partially with some success.
public boolean	isPartialSuccess() Implements io.netty.channel.group.ChannelGroupFuture.isPartialSuccess. Returns `true` if and only if the I/O operations associated with this future were partially successful with some failure.
public boolean	isSuccess() Implements io.netty.channel.group.ChannelGroupFuture.isSuccess. Returns `true` if and only if all I/O operations associated with this future were successful without any failure.
public Iterator<ChannelFuture>	iterator() Implements io.netty.channel.group.ChannelGroupFuture.iterator. Returns the `Iterator` that enumerates all `ChannelFuture`s which are associated with this future.
private static RuntimeException	reject()
public ChannelGroupFuture	removeListener(GenericFutureListener<? extends Future<? super Void>> listener) Implements io.netty.channel.group.ChannelGroupFuture.removeListener. Removes the first occurrence of the specified listener from this future.
public ChannelGroupFuture	removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) Implements io.netty.channel.group.ChannelGroupFuture.removeListeners. Removes the first occurrence for each of the listeners from this future.
public ChannelGroupFuture	sync() Implements io.netty.channel.group.ChannelGroupFuture.sync. Waits for this future until it is done, and rethrows the cause of the failure if this future failed.
public ChannelGroupFuture	syncUninterruptibly() Implements io.netty.channel.group.ChannelGroupFuture.syncUninterruptibly. Waits for this future until it is done, and rethrows the cause of the failure if this future failed.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

EMPTY	back to summary
private static final Iterator<ChannelFuture> EMPTY

group	back to summary
private final ChannelGroup group

VoidChannelGroupFuture	back to summary
pack-priv VoidChannelGroupFuture(ChannelGroup group)

Method Detail

addListener	back to summary
public ChannelGroupFuture addListener(GenericFutureListener<? extends Future<? super Void>> listener) Implements io.netty.channel.group.ChannelGroupFuture.addListener. Doc from io.netty.util.concurrent.Future.addListener. 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. Annotations @Override

addListener

back to summary

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

Implements io.netty.channel.group.ChannelGroupFuture.addListener.

Doc from io.netty.util.concurrent.Future.addListener.

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.

Annotations

@Override

addListeners	back to summary
public ChannelGroupFuture addListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) Implements io.netty.channel.group.ChannelGroupFuture.addListeners. Doc from io.netty.util.concurrent.Future.addListeners. 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. Annotations @Override

addListeners

back to summary

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

Implements io.netty.channel.group.ChannelGroupFuture.addListeners.

Doc from io.netty.util.concurrent.Future.addListeners.

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.

Annotations

@Override

await	back to summary
public ChannelGroupFuture await() Implements io.netty.channel.group.ChannelGroupFuture.await. Doc from io.netty.util.concurrent.Future.await. Waits for this future to be completed. Annotations @Override

await

back to summary

public ChannelGroupFuture await()

Implements io.netty.channel.group.ChannelGroupFuture.await.

Doc from io.netty.util.concurrent.Future.await.

Waits for this future to be completed.

Annotations

@Override

await back to summary

await	back to summary
public boolean await(long timeout, TimeUnit unit) Implements io.netty.util.concurrent.Future.await. Doc from io.netty.util.concurrent.Future.await. Waits for this future to be completed within the specified time limit. Returns:boolean `true` if and only if the future was completed within the specified time limit Annotations @Override

public boolean await(long timeout, TimeUnit unit)

Implements io.netty.util.concurrent.Future.await.

Doc from io.netty.util.concurrent.Future.await.

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

Returns:boolean

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

Annotations

@Override

await back to summary

await	back to summary
public boolean await(long timeoutMillis) Implements io.netty.util.concurrent.Future.await. Doc from io.netty.util.concurrent.Future.await. Waits for this future to be completed within the specified time limit. Returns:boolean `true` if and only if the future was completed within the specified time limit Annotations @Override

public boolean await(long timeoutMillis)

Implements io.netty.util.concurrent.Future.await.

Doc from io.netty.util.concurrent.Future.await.

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

Returns:boolean

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

Annotations

@Override

awaitUninterruptibly back to summary

awaitUninterruptibly	back to summary
public ChannelGroupFuture awaitUninterruptibly() Implements io.netty.channel.group.ChannelGroupFuture.awaitUninterruptibly. Doc from io.netty.util.concurrent.Future.awaitUninterruptibly. Waits for this future to be completed without interruption. This method catches an `InterruptedException` and discards it silently. Annotations @Override

public ChannelGroupFuture awaitUninterruptibly()

Implements io.netty.channel.group.ChannelGroupFuture.awaitUninterruptibly.

Doc from io.netty.util.concurrent.Future.awaitUninterruptibly.

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

Annotations

@Override

awaitUninterruptibly back to summary

awaitUninterruptibly	back to summary
public boolean awaitUninterruptibly(long timeout, TimeUnit unit) Implements io.netty.util.concurrent.Future.awaitUninterruptibly. Doc from io.netty.util.concurrent.Future.awaitUninterruptibly. Waits for this future to be completed within the specified time limit without interruption. This method catches an `InterruptedException` and discards it silently. Returns:boolean `true` if and only if the future was completed within the specified time limit Annotations @Override

public boolean awaitUninterruptibly(long timeout, TimeUnit unit)

Implements io.netty.util.concurrent.Future.awaitUninterruptibly.

Doc from io.netty.util.concurrent.Future.awaitUninterruptibly.

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

Returns:boolean

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

Annotations

@Override

awaitUninterruptibly back to summary

awaitUninterruptibly	back to summary
public boolean awaitUninterruptibly(long timeoutMillis) Implements io.netty.util.concurrent.Future.awaitUninterruptibly. Doc from io.netty.util.concurrent.Future.awaitUninterruptibly. Waits for this future to be completed within the specified time limit without interruption. This method catches an `InterruptedException` and discards it silently. Returns:boolean `true` if and only if the future was completed within the specified time limit Annotations @Override

public boolean awaitUninterruptibly(long timeoutMillis)

Implements io.netty.util.concurrent.Future.awaitUninterruptibly.

Doc from io.netty.util.concurrent.Future.awaitUninterruptibly.

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

Returns:boolean

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

Annotations

@Override

cancel back to summary

cancel	back to summary
public boolean cancel(boolean mayInterruptIfRunning) Implements io.netty.util.concurrent.Future.cancel. Doc from io.netty.util.concurrent.Future.cancel. Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when `cancel` is called, this task should never run. If the task has already started, then the `mayInterruptIfRunning` parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task. The return value from this method does not necessarily indicate whether the task is now cancelled; use `isCancelled`. If the cancellation was successful it will fail the future with a `CancellationException`. Parameters mayInterruptIfRunning:boolean this value has no effect in this implementation. Returns:boolean Doc from java.util.concurrent.Future.cancel. `false` if the task could not be cancelled, typically because it has already completed; `true` otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns `true`. Implementations may provide stronger guarantees. Annotations @Override

public boolean cancel(boolean mayInterruptIfRunning)

Implements io.netty.util.concurrent.Future.cancel.

Doc from io.netty.util.concurrent.Future.cancel.

Attempts to cancel execution of this task. This method has no effect if the task is already completed or cancelled, or could not be cancelled for some other reason. Otherwise, if this task has not started when cancel is called, this task should never run. If the task has already started, then the mayInterruptIfRunning parameter determines whether the thread executing this task (when known by the implementation) is interrupted in an attempt to stop the task.

The return value from this method does not necessarily indicate whether the task is now cancelled; use isCancelled. If the cancellation was successful it will fail the future with a CancellationException.

Parameters

mayInterruptIfRunning:boolean: this value has no effect in this implementation.

Returns:boolean

Doc from java.util.concurrent.Future.cancel.

false if the task could not be cancelled, typically because it has already completed; true otherwise. If two or more threads cause a task to be cancelled, then at least one of them returns true. Implementations may provide stronger guarantees.

Annotations

@Override

cause back to summary

cause	back to summary
public ChannelGroupException cause() Implements io.netty.channel.group.ChannelGroupFuture.cause. Doc from io.netty.util.concurrent.Future.cause. Returns the cause of the failed I/O operation if the I/O operation has failed. Returns:ChannelGroupException the cause of the failure. `null` if succeeded or this future is not completed yet. Annotations @Override

public ChannelGroupException cause()

Implements io.netty.channel.group.ChannelGroupFuture.cause.

Doc from io.netty.util.concurrent.Future.cause.

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

Returns:ChannelGroupException

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

Annotations

@Override

find back to summary

find	back to summary
public ChannelFuture find(Channel channel) Implements io.netty.channel.group.ChannelGroupFuture.find. Doc from io.netty.channel.group.ChannelGroupFuture.find. Returns the `ChannelFuture` of the individual I/O operation which is associated with the specified `Channel`. Returns:ChannelFuture the matching `ChannelFuture` if found. `null` otherwise. Annotations @Override

public ChannelFuture find(Channel channel)

Implements io.netty.channel.group.ChannelGroupFuture.find.

Doc from io.netty.channel.group.ChannelGroupFuture.find.

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

Returns:ChannelFuture

the matching ChannelFuture if found. null otherwise.

Annotations

@Override

get	back to summary
public Void get() Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for the computation to complete, and then retrieves its result. Returns:Void the computed result Annotations @Override

get

back to summary

public Void get()

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for the computation to complete, and then retrieves its result.

Returns:Void

the computed result

Annotations

@Override

get	back to summary
public Void get(long timeout, TimeUnit unit) Implements java.util.concurrent.Future.get. Doc from java.util.concurrent.Future.get. Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available. Parameters timeout:long the maximum time to wait unit:TimeUnit the time unit of the timeout argument Returns:Void the computed result Annotations @Override

get

back to summary

public Void get(long timeout, TimeUnit unit)

Implements java.util.concurrent.Future.get.

Doc from java.util.concurrent.Future.get.

Waits if necessary for at most the given time for the computation to complete, and then retrieves its result, if available.

Parameters

timeout:long: the maximum time to wait
unit:TimeUnit: the time unit of the timeout argument

Returns:Void

the computed result

Annotations

@Override

getNow back to summary

getNow	back to summary
public Void getNow() Implements io.netty.util.concurrent.Future.getNow. Doc from io.netty.util.concurrent.Future.getNow. 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 `isDone()` and not rely on the returned `null` value. Annotations @Override

public Void getNow()

Implements io.netty.util.concurrent.Future.getNow.

Doc from io.netty.util.concurrent.Future.getNow.

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 isDone() and not rely on the returned null value.

Annotations

@Override

group back to summary

group	back to summary
public ChannelGroup group() Implements io.netty.channel.group.ChannelGroupFuture.group. Doc from io.netty.channel.group.ChannelGroupFuture.group. Returns the `ChannelGroup` which is associated with this future. Annotations @Override

public ChannelGroup group()

Implements io.netty.channel.group.ChannelGroupFuture.group.

Doc from io.netty.channel.group.ChannelGroupFuture.group.

Returns the ChannelGroup which is associated with this future.

Annotations

@Override

isCancellable back to summary

isCancellable	back to summary
public boolean isCancellable() Implements io.netty.util.concurrent.Future.isCancellable. Doc from io.netty.util.concurrent.Future.isCancellable. returns `true` if and only if the operation can be cancelled via `cancel(boolean)`. Annotations @Override

public boolean isCancellable()

Implements io.netty.util.concurrent.Future.isCancellable.

Doc from io.netty.util.concurrent.Future.isCancellable.

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

Annotations

@Override

isCancelled back to summary

isCancelled	back to summary
public boolean isCancelled() Implements java.util.concurrent.Future.isCancelled. Doc from java.util.concurrent.Future.isCancelled. Returns `true` if this task was cancelled before it completed normally. Returns:boolean `true` if this task was cancelled before it completed Annotations @Override

public boolean isCancelled()

Implements java.util.concurrent.Future.isCancelled.

Doc from java.util.concurrent.Future.isCancelled.

Returns true if this task was cancelled before it completed normally.

Returns:boolean

true if this task was cancelled before it completed

Annotations

@Override

isDone back to summary

isDone	back to summary
public boolean isDone() Implements java.util.concurrent.Future.isDone. Doc from java.util.concurrent.Future.isDone. Returns `true` if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return `true`. Returns:boolean `true` if this task completed Annotations @Override

public boolean isDone()

Implements java.util.concurrent.Future.isDone.

Doc from java.util.concurrent.Future.isDone.

Returns true if this task completed. Completion may be due to normal termination, an exception, or cancellation -- in all of these cases, this method will return true.

Returns:boolean

true if this task completed

Annotations

@Override

isPartialFailure back to summary

isPartialFailure	back to summary
public boolean isPartialFailure() Implements io.netty.channel.group.ChannelGroupFuture.isPartialFailure. Doc from io.netty.channel.group.ChannelGroupFuture.isPartialFailure. Returns `true` if and only if the I/O operations associated with this future have failed partially with some success. Annotations @Override

public boolean isPartialFailure()

Implements io.netty.channel.group.ChannelGroupFuture.isPartialFailure.

Doc from io.netty.channel.group.ChannelGroupFuture.isPartialFailure.

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

Annotations

@Override

isPartialSuccess back to summary

isPartialSuccess	back to summary
public boolean isPartialSuccess() Implements io.netty.channel.group.ChannelGroupFuture.isPartialSuccess. Doc from io.netty.channel.group.ChannelGroupFuture.isPartialSuccess. Returns `true` if and only if the I/O operations associated with this future were partially successful with some failure. Annotations @Override

public boolean isPartialSuccess()

Implements io.netty.channel.group.ChannelGroupFuture.isPartialSuccess.

Doc from io.netty.channel.group.ChannelGroupFuture.isPartialSuccess.

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

Annotations

@Override

isSuccess back to summary

isSuccess	back to summary
public boolean isSuccess() Implements io.netty.channel.group.ChannelGroupFuture.isSuccess. Doc from io.netty.channel.group.ChannelGroupFuture.isSuccess. Returns `true` if and only if all I/O operations associated with this future were successful without any failure. Annotations @Override

public boolean isSuccess()

Implements io.netty.channel.group.ChannelGroupFuture.isSuccess.

Doc from io.netty.channel.group.ChannelGroupFuture.isSuccess.

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

Annotations

@Override

iterator back to summary

iterator	back to summary
public Iterator<ChannelFuture> iterator() Implements io.netty.channel.group.ChannelGroupFuture.iterator. Doc from io.netty.channel.group.ChannelGroupFuture.iterator. Returns the `Iterator` that enumerates all `ChannelFuture`s which are associated with this future. Please note that the returned `Iterator` is is unmodifiable, which means a `ChannelFuture` cannot be removed from this future. Returns:Iterator<ChannelFuture> Doc from java.lang.Iterable.iterator. an Iterator. Annotations @Override

public Iterator<ChannelFuture> iterator()

Implements io.netty.channel.group.ChannelGroupFuture.iterator.

Doc from io.netty.channel.group.ChannelGroupFuture.iterator.

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

Returns:Iterator<ChannelFuture>

Doc from java.lang.Iterable.iterator.

an Iterator.

Annotations

@Override

reject	back to summary
private static RuntimeException reject()

removeListener	back to summary
public ChannelGroupFuture removeListener(GenericFutureListener<? extends Future<? super Void>> listener) Implements io.netty.channel.group.ChannelGroupFuture.removeListener. Doc from io.netty.util.concurrent.Future.removeListener. 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. Annotations @Override

removeListener

back to summary

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

Implements io.netty.channel.group.ChannelGroupFuture.removeListener.

Doc from io.netty.util.concurrent.Future.removeListener.

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.

Annotations

@Override

removeListeners	back to summary
public ChannelGroupFuture removeListeners(GenericFutureListener<? extends Future<? super Void>>... listeners) Implements io.netty.channel.group.ChannelGroupFuture.removeListeners. Doc from io.netty.util.concurrent.Future.removeListeners. 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. Annotations @Override

removeListeners

back to summary

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

Implements io.netty.channel.group.ChannelGroupFuture.removeListeners.

Doc from io.netty.util.concurrent.Future.removeListeners.

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.

Annotations

@Override

sync	back to summary
public ChannelGroupFuture sync() Implements io.netty.channel.group.ChannelGroupFuture.sync. Doc from io.netty.util.concurrent.Future.sync. Waits for this future until it is done, and rethrows the cause of the failure if this future failed. Annotations @Override

sync

back to summary

public ChannelGroupFuture sync()

Implements io.netty.channel.group.ChannelGroupFuture.sync.

Doc from io.netty.util.concurrent.Future.sync.

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

Annotations

@Override

syncUninterruptibly	back to summary
public ChannelGroupFuture syncUninterruptibly() Implements io.netty.channel.group.ChannelGroupFuture.syncUninterruptibly. Doc from io.netty.util.concurrent.Future.syncUninterruptibly. Waits for this future until it is done, and rethrows the cause of the failure if this future failed. Annotations @Override

syncUninterruptibly

back to summary

public ChannelGroupFuture syncUninterruptibly()

Implements io.netty.channel.group.ChannelGroupFuture.syncUninterruptibly.

Doc from io.netty.util.concurrent.Future.syncUninterruptibly.

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

Annotations

@Override

pack-priv final Class VoidChannelGroupFuture

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail