# AsynchronousChannelGroup

public abstract class **AsynchronousChannelGroup** extends [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)  
A grouping of asynchronous channels for the purpose of resource sharing.

An asynchronous channel group encapsulates the mechanics required to
handle the completion of I/O operations initiated by `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannel.html` that are bound to the group. A group has an associated
thread pool to which tasks are submitted to handle I/O events and dispatch to
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/CompletionHandler.html` that consume the result of
asynchronous operations performed on channels in the group. In addition to
handling I/O events, the pooled threads may also execute other tasks required
to support the execution of asynchronous I/O operations.

An asynchronous channel group is created by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withFixedThreadPool(int,%20java.util.concurrent.ThreadFactory)` or `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withCachedThreadPool(java.util.concurrent.ExecutorService,%20int)` methods defined here. Channels are bound to a group by
specifying the group when constructing the channel. The associated thread
pool is *owned* by the group; termination of the group results in the
shutdown of the associated thread pool.

In addition to groups created explicitly, the Java virtual machine
maintains a system-wide *default group* that is constructed
automatically. Asynchronous channels that do not specify a group at
construction time are bound to the default group. The default group has an
associated thread pool that creates new threads as needed. The default group
may be configured by means of system properties defined in the table below.
Where the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html` for the
default group is not configured then the pooled threads of the default group
are `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Thread.html#isDaemon()` threads.

| System property | Description |
|---|---|
| `java.nio.channels.DefaultThreadPool.threadFactory` | The value of this property is taken to be the fully-qualified name of a concrete `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html` class. The class is loaded using the system class loader and instantiated. The factory's `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html#newThread(java.lang.Runnable)` method is invoked to create each thread for the default group's thread pool. If the process to load and instantiate the value of the property fails then an unspecified error is thrown during the construction of the default group. |
| `java.nio.channels.DefaultThreadPool.initialSize` | The value of the `initialSize` parameter for the default group (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withCachedThreadPool(java.util.concurrent.ExecutorService,%20int)`). The value of the property is taken to be the `String` representation of an `Integer` that is the initial size parameter. If the value cannot be parsed as an `Integer` it causes an unspecified error to be thrown during the construction of the default group. |

## Threading

The completion handler for an I/O operation initiated on a channel bound
to a group is guaranteed to be invoked by one of the pooled threads in the
group. This ensures that the completion handler is run by a thread with the
expected *identity*.

Where an I/O operation completes immediately, and the initiating thread
is one of the pooled threads in the group then the completion handler may
be invoked directly by the initiating thread. To avoid stack overflow, an
implementation may impose a limit as to the number of activations on the
thread stack. Some I/O operations may prohibit invoking the completion
handler directly by the initiating thread (see `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousServerSocketChannel.html#accept(A,%20java.nio.channels.CompletionHandler<java.nio.channels.AsynchronousSocketChannel,%20?%20super%20A>)`).

## Shutdown and Termination

The `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#shutdown()` method is used to initiate an *orderly
shutdown* of a group. An orderly shutdown marks the group as shutdown;
further attempts to construct a channel that binds to the group will throw
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ShutdownChannelGroupException.html`. Whether or not a group is shutdown can
be tested using the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#isShutdown()` method. Once shutdown,
the group *terminates* when all asynchronous channels that are bound to
the group are closed, all actively executing completion handlers have run to
completion, and resources used by the group are released. No attempt is made
to stop or interrupt threads that are executing completion handlers. The
`https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#isTerminated()` method is used to test if the group has
terminated, and the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#awaitTermination(long,%20java.util.concurrent.TimeUnit)` method can be
used to block until the group has terminated.

The `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#shutdownNow()` method can be used to initiate a
*forceful shutdown* of the group. In addition to the actions performed
by an orderly shutdown, the `shutdownNow` method closes all open channels
in the group as if by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannel.html#close()`
method.

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousSocketChannel.html#open(java.nio.channels.AsynchronousChannelGroup)`
- `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousServerSocketChannel.html#open(java.nio.channels.AsynchronousChannelGroup)`

### Protected Constructor Summary

|---|---|
|   | [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#AsynchronousChannelGroup(java.nio.channels.spi.AsynchronousChannelProvider))([AsynchronousChannelProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html) provider) Initialize a new instance of this class. |

### Public Method Summary

|---|---|
| abstract boolean | [awaitTermination](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#awaitTermination(long,%20java.util.concurrent.TimeUnit))(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit) Awaits termination of the group. |
| abstract boolean | [isShutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#isShutdown())() Tells whether or not this asynchronous channel group is shutdown. |
| abstract boolean | [isTerminated](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#isTerminated())() Tells whether or not this group has terminated. |
| final [AsynchronousChannelProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html) | [provider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#provider())() Returns the provider that created this channel group. |
| abstract void | [shutdown](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#shutdown())() Initiates an orderly shutdown of the group. |
| abstract void | [shutdownNow](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#shutdownNow())() Shuts down the group and closes all open channels in the group. |
| static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html) | [withCachedThreadPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withCachedThreadPool(java.util.concurrent.ExecutorService,%20int))([ExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html) executor, int initialSize) Creates an asynchronous channel group with a given thread pool that creates new threads as needed. |
| static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html) | [withFixedThreadPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withFixedThreadPool(int,%20java.util.concurrent.ThreadFactory))(int nThreads, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory) Creates an asynchronous channel group with a fixed thread pool. |
| static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html) | [withThreadPool](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#withThreadPool(java.util.concurrent.ExecutorService))([ExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html) executor) Creates an asynchronous channel group with a given thread pool. |

### Inherited Method Summary

From class [java.lang.Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html)

|---|---|
| [Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) | [clone](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#clone())() Creates and returns a copy of this `Object`. |
| boolean | [equals](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#equals(java.lang.Object))([Object](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html) obj) Compares this instance with the specified object and indicates if they are equal. |
| void | [finalize](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#finalize())() Invoked when the garbage collector has detected that this instance is no longer reachable. |
| final [Class](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html)\<?\> | [getClass](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#getClass())() Returns the unique instance of `https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Class.html` that represents this object's class. |
| int | [hashCode](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#hashCode())() Returns an integer hash code for this object. |
| final void | [notify](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notify())() Causes a thread which is waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| final void | [notifyAll](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#notifyAll())() Causes all threads which are waiting on this object's monitor (by means of calling one of the `wait()` methods) to be woken up. |
| [String](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/String.html) | [toString](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#toString())() Returns a string containing a concise, human-readable description of this object. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long,%20int))(long timeout, int nanos) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait(long))(long timeout) Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object or until the specified timeout expires. |
| final void | [wait](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/Object.html#wait())() Causes the calling thread to wait until another thread calls the `notify()` or `notifyAll()` method of this object. |

## Protected Constructors

#### protected
**AsynchronousChannelGroup**
([AsynchronousChannelProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html) provider)

Initialize a new instance of this class.

##### Parameters

| provider | The asynchronous channel provider for this group |
|---|---|

## Public Methods

#### public abstract boolean
**awaitTermination**
(long timeout, [TimeUnit](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/TimeUnit.html) unit)

Awaits termination of the group.

This method blocks until the group has terminated, or the timeout
occurs, or the current thread is interrupted, whichever happens first.

##### Parameters

| timeout | The maximum time to wait, or zero or less to not wait |
| unit | The time unit of the timeout argument |
|---|---|

##### Returns

- `true` if the group has terminated; `false` if the timeout elapsed before termination

##### Throws

| [InterruptedException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/InterruptedException.html) | If interrupted while waiting |
|---|---|

#### public abstract boolean
**isShutdown**
()

Tells whether or not this asynchronous channel group is shutdown.

##### Returns

- `true` if this asynchronous channel group is shutdown or has been marked for shutdown.

#### public abstract boolean
**isTerminated**
()

Tells whether or not this group has terminated.

Where this method returns `true`, then the associated thread
pool has also `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#isTerminated()`.

##### Returns

- `true` if this group has terminated

#### public final [AsynchronousChannelProvider](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html)
**provider**
()

Returns the provider that created this channel group.

##### Returns

- The provider that created this channel group

#### public abstract void
**shutdown**
()

Initiates an orderly shutdown of the group.

This method marks the group as shutdown. Further attempts to construct
channel that binds to this group will throw `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/ShutdownChannelGroupException.html`.
The group terminates when all asynchronous channels in the group are
closed, all actively executing completion handlers have run to completion,
and all resources have been released. This method has no effect if the
group is already shutdown.

#### public abstract void
**shutdownNow**
()

Shuts down the group and closes all open channels in the group.

In addition to the actions performed by the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html#shutdown()`
method, this method invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannel.html#close()`
method on all open channels in the group. This method does not attempt to
stop or interrupt threads that are executing completion handlers. The
group terminates when all actively executing completion handlers have run
to completion and all resources have been released. This method may be
invoked at any time. If some other thread has already invoked it, then
another invocation will block until the first invocation is complete,
after which it will return without effect.

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html)
**withCachedThreadPool**
([ExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html) executor, int initialSize)

Creates an asynchronous channel group with a given thread pool that
creates new threads as needed.

The `executor` parameter is an `ExecutorService` that
creates new threads as needed to execute tasks that are submitted to
handle I/O events and dispatch completion results for operations initiated
on asynchronous channels in the group. It may reuse previously constructed
threads when they are available.

The `initialSize` parameter may be used by the implementation
as a *hint* as to the initial number of tasks it may submit. For
example, it may be used to indicate the initial number of threads that
wait on I/O events.

The executor is intended to be used exclusively by the resulting
asynchronous channel group. Termination of the group results in the
orderly `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#shutdown()` of the executor
service. Shutting down the executor service by other means results in
unspecified behavior.

The group is created by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html#openAsynchronousChannelGroup(java.util.concurrent.ExecutorService,%20int)` method of the system-wide
default `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html` object.

##### Parameters

| executor | The thread pool for the resulting group |
| initialSize | A value `>=0` or a negative value for implementation specific default |
|---|---|

##### Returns

- A new asynchronous channel group

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

##### See Also

- `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executors.html#newCachedThreadPool()`

#### public static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html)
**withFixedThreadPool**
(int nThreads, [ThreadFactory](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ThreadFactory.html) threadFactory)

Creates an asynchronous channel group with a fixed thread pool.

The resulting asynchronous channel group reuses a fixed number of
threads. At any point, at most `nThreads` threads will be active
processing tasks that are submitted to handle I/O events and dispatch
completion results for operations initiated on asynchronous channels in
the group.

The group is created by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html#openAsynchronousChannelGroup(int,%20java.util.concurrent.ThreadFactory)` method of the system-wide
default `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html` object.

##### Parameters

| nThreads | The number of threads in the pool |
| threadFactory | The factory to use when creating new threads |
|---|---|

##### Returns

- A new asynchronous channel group

##### Throws

| [IllegalArgumentException](https://developers.google.com/j2objc/javadoc/jre/reference/java/lang/IllegalArgumentException.html) | If `nThreads <= 0` |
| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|

#### public static [AsynchronousChannelGroup](https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/AsynchronousChannelGroup.html)
**withThreadPool**
([ExecutorService](https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html) executor)

Creates an asynchronous channel group with a given thread pool.

The `executor` parameter is an `ExecutorService` that
executes tasks submitted to dispatch completion results for operations
initiated on asynchronous channels in the group.

Care should be taken when configuring the executor service. It
should support *direct handoff* or *unbounded queuing* of
submitted tasks, and the thread that invokes the `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/Executor.html#execute(java.lang.Runnable)` method should never invoke the task
directly. An implementation may mandate additional constraints.

The executor is intended to be used exclusively by the resulting
asynchronous channel group. Termination of the group results in the
orderly `https://developers.google.com/j2objc/javadoc/jre/reference/java/util/concurrent/ExecutorService.html#shutdown()` of the executor
service. Shutting down the executor service by other means results in
unspecified behavior.

The group is created by invoking the `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html#openAsynchronousChannelGroup(java.util.concurrent.ExecutorService,%20int)` method of the system-wide
default `https://developers.google.com/j2objc/javadoc/jre/reference/java/nio/channels/spi/AsynchronousChannelProvider.html` object with an `initialSize` of `0`.

##### Parameters

| executor | The thread pool for the resulting group |
|---|---|

##### Returns

- A new asynchronous channel group

##### Throws

| [IOException](https://developers.google.com/j2objc/javadoc/jre/reference/java/io/IOException.html) | If an I/O error occurs |
|---|---|