AsynchronousChannelProvider

public abstract class AsynchronousChannelProvider
extends Object

java.lang.Object
   ↳ java.nio.channels.spi.AsynchronousChannelProvider


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.

Summary

Protected constructors

AsynchronousChannelProvider()

Initializes a new instance of this class.

Public methods

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 methods

Protected constructors

AsynchronousChannelProvider

added in API level 26
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

openAsynchronousChannelGroup

added in API level 26
public abstract AsynchronousChannelGroup openAsynchronousChannelGroup (int nThreads, 
                ThreadFactory threadFactory)

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

Parameters
nThreads int: The number of threads in the pool

threadFactory ThreadFactory: The factory to use when creating new threads

Returns
AsynchronousChannelGroup A new asynchronous channel group

Throws
IllegalArgumentException If nThreads <= 0
IOException If an I/O error occurs

openAsynchronousChannelGroup

added in API level 26
public abstract AsynchronousChannelGroup openAsynchronousChannelGroup (ExecutorService executor, 
                int initialSize)

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

Parameters
executor ExecutorService: The thread pool

initialSize int: A value >=0 or a negative value for implementation specific default

Returns
AsynchronousChannelGroup A new asynchronous channel group

Throws
IOException If an I/O error occurs

openAsynchronousServerSocketChannel

added in API level 26
public abstract AsynchronousServerSocketChannel openAsynchronousServerSocketChannel (AsynchronousChannelGroup group)

Opens an asynchronous server-socket channel.

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

Returns
AsynchronousServerSocketChannel 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

openAsynchronousSocketChannel

added in API level 26
public abstract AsynchronousSocketChannel openAsynchronousSocketChannel (AsynchronousChannelGroup group)

Opens an asynchronous socket channel.

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

Returns
AsynchronousSocketChannel 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

provider

added in API level 26
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
AsynchronousChannelProvider The system-wide default AsynchronousChannel provider