AsynchronousChannelProvider

public abstract class AsynchronousChannelProvider extends Object

Service-provider class for asynchronous channels.

An asynchronous channel provider is a concrete subclass of this class that has a zero-argument constructor and implements the abstract methods specified below. A given invocation of the Java virtual machine maintains a single system-wide default provider instance, which is returned by the provider method. The first invocation of that method will locate the default provider as specified below.

All of the methods in this class are safe for use by multiple concurrent threads.

Protected Constructor Summary

AsynchronousChannelProvider() Initializes a new instance of this class.

Public Method Summary

abstract AsynchronousChannelGroup	openAsynchronousChannelGroup(int nThreads, ThreadFactory threadFactory) Constructs a new asynchronous channel group with a fixed thread pool.
abstract AsynchronousChannelGroup	openAsynchronousChannelGroup(ExecutorService executor, int initialSize) Constructs a new asynchronous channel group with the given thread pool.
abstract AsynchronousServerSocketChannel	openAsynchronousServerSocketChannel(AsynchronousChannelGroup group) Opens an asynchronous server-socket channel.
abstract AsynchronousSocketChannel	openAsynchronousSocketChannel(AsynchronousChannelGroup group) Opens an asynchronous socket channel.
static AsynchronousChannelProvider	provider() Returns the system-wide default asynchronous channel provider for this invocation of the Java virtual machine.

Inherited Method Summary

From class java.lang.Object

Object	clone() Creates and returns a copy of this Object.
boolean	equals(Object obj) Compares this instance with the specified object and indicates if they are equal.
void	finalize() Invoked when the garbage collector has detected that this instance is no longer reachable.
final Class<?>	getClass() Returns the unique instance of Class that represents this object's class.
int	hashCode() Returns an integer hash code for this object.
final void	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() 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	toString() Returns a string containing a concise, human-readable description of this object.
final void	wait(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(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() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object.

Protected Constructors

protected AsynchronousChannelProvider ()

Initializes a new instance of this class.

Throws

SecurityException	If a security manager has been installed and it denies RuntimePermission("asynchronousChannelProvider")

Public Methods

public abstract AsynchronousChannelGroup openAsynchronousChannelGroup (int nThreads, ThreadFactory threadFactory)

Constructs a new asynchronous channel group with a fixed thread pool.

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	If nThreads <= 0
IOException	If an I/O error occurs

See Also

• AsynchronousChannelGroup.withFixedThreadPool(int, ThreadFactory)

public abstract AsynchronousChannelGroup openAsynchronousChannelGroup (ExecutorService executor, int initialSize)

Constructs a new asynchronous channel group with the given thread pool.

Parameters

executor	The thread pool
initialSize	A value >=0 or a negative value for implementation specific default

Returns

• A new asynchronous channel group

Throws

IOException	If an I/O error occurs

See Also

• AsynchronousChannelGroup.withCachedThreadPool(ExecutorService, int)

public abstract AsynchronousServerSocketChannel openAsynchronousServerSocketChannel (AsynchronousChannelGroup group)

Opens an asynchronous server-socket channel.

Parameters

group	The group to which the channel is bound, or null to bind to the default group

Returns

• The new channel

Throws

IllegalChannelGroupException	If the provider that created the group differs from this provider
ShutdownChannelGroupException	The group is shutdown
IOException	If an I/O error occurs

public abstract AsynchronousSocketChannel openAsynchronousSocketChannel (AsynchronousChannelGroup group)

Opens an asynchronous socket channel.

Parameters

group	The group to which the channel is bound, or null to bind to the default group

Returns

• The new channel

Throws

IllegalChannelGroupException	If the provider that created the group differs from this provider
ShutdownChannelGroupException	The group is shutdown
IOException	If an I/O error occurs

public static AsynchronousChannelProvider provider ()

Returns the system-wide default asynchronous channel provider for this invocation of the Java virtual machine.

The first invocation of this method locates the default provider object as follows:

1. If the system property java.nio.channels.spi.AsynchronousChannelProvider is defined then it is taken to be the fully-qualified name of a concrete provider class. The class is loaded and instantiated; if this process fails then an unspecified error is thrown.

2. If a provider class has been installed in a jar file that is visible to the system class loader, and that jar file contains a provider-configuration file named java.nio.channels.spi.AsynchronousChannelProvider in the resource directory META-INF/services, then the first class name specified in that file is taken. The class is loaded and instantiated; if this process fails then an unspecified error is thrown.

3. Finally, if no provider has been specified by any of the above means then the system-default provider class is instantiated and the result is returned.

Subsequent invocations of this method return the provider that was returned by the first invocation.

Returns

• The system-wide default AsynchronousChannel provider