Top Description Inners Constructors Methods
java.nio.channels.spi

public abstract Class AsynchronousChannelProvider

extends Object
Class Inheritance
Known Direct Subclasses
sun.nio.ch.LinuxAsynchronousChannelProvider
Imports
java.nio.channels.*, java.io.IOException, java.util.Iterator, .ServiceLoader, .ServiceConfigurationError, java.util.concurrent.*, java.security.AccessController, .PrivilegedAction

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.

Since
1.7

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class

Constructor Summary

AccessConstructor and Description
private
protected
AsynchronousChannelProvider()

Initializes a new instance of this class.

Method Summary

Modifier and TypeMethod and Description
private static Void
public abstract AsynchronousChannelGroup

Returns:

A new asynchronous channel group
openAsynchronousChannelGroup
(int
The number of threads in the pool
nThreads
,
ThreadFactory
The factory to use when creating new threads
threadFactory
)

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

public abstract AsynchronousChannelGroup

Returns:

A new asynchronous channel group
openAsynchronousChannelGroup
(ExecutorService
The thread pool
executor
,
int
A value >=0 or a negative value for implementation specific default
initialSize
)

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

public abstract AsynchronousServerSocketChannel

Returns:

The new channel
openAsynchronousServerSocketChannel
(AsynchronousChannelGroup
The group to which the channel is bound, or null to bind to the default group
group
)

Opens an asynchronous server-socket channel.

public abstract AsynchronousSocketChannel

Returns:

The new channel
openAsynchronousSocketChannel
(AsynchronousChannelGroup
The group to which the channel is bound, or null to bind to the default group
group
)

Opens an asynchronous socket channel.

public static AsynchronousChannelProvider

Returns:

The system-wide default AsynchronousChannel provider
provider
()

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

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

AsynchronousChannelProviderback to summary
private AsynchronousChannelProvider(Void ignore)
AsynchronousChannelProviderback to summary
protected AsynchronousChannelProvider()

Initializes a new instance of this class.

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

Method Detail

checkPermissionback to summary
private static Void checkPermission()
openAsynchronousChannelGroupback to summary
public abstract AsynchronousChannelGroup openAsynchronousChannelGroup(int nThreads, ThreadFactory threadFactory) throws IOException

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

Exceptions
IOException:
If an I/O error occurs
IllegalArgumentException:
If nThreads <= 0
See Also
AsynchronousChannelGroup#withFixedThreadPool
openAsynchronousChannelGroupback to summary
public abstract AsynchronousChannelGroup openAsynchronousChannelGroup(ExecutorService executor, int initialSize) throws IOException

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

Exceptions
IOException:
If an I/O error occurs
See Also
AsynchronousChannelGroup#withCachedThreadPool
openAsynchronousServerSocketChannelback to summary
public abstract AsynchronousServerSocketChannel openAsynchronousServerSocketChannel(AsynchronousChannelGroup group) throws IOException

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

Exceptions
IOException:
If an I/O error occurs
IllegalChannelGroupException:
If the provider that created the group differs from this provider
ShutdownChannelGroupException:
The group is shutdown
openAsynchronousSocketChannelback to summary
public abstract AsynchronousSocketChannel openAsynchronousSocketChannel(AsynchronousChannelGroup group) throws IOException

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

Exceptions
IOException:
If an I/O error occurs
IllegalChannelGroupException:
If the provider that created the group differs from this provider
ShutdownChannelGroupException:
The group is shutdown
providerback to summary
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

java.nio.channels.spi back to summary

private Class AsynchronousChannelProvider.ProviderHolder

extends Object
Class Inheritance
  • java.lang.Object
  • java.nio.channels.spi.AsynchronousChannelProvider.ProviderHolder

Field Summary

Modifier and TypeField and Description
pack-priv static final AsynchronousChannelProvider

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
private static AsynchronousChannelProvider
load()

private static AsynchronousChannelProvider
private static AsynchronousChannelProvider
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

providerback to summary
pack-priv static final AsynchronousChannelProvider provider

Constructor Detail

ProviderHolderback to summary
private ProviderHolder()

Method Detail

loadback to summary
private static AsynchronousChannelProvider load()
Annotations
@SuppressWarnings:removal
loadProviderAsServiceback to summary
private static AsynchronousChannelProvider loadProviderAsService()
loadProviderFromPropertyback to summary
private static AsynchronousChannelProvider loadProviderFromProperty()