com.sun.sgs.nio.channels.spi
Class AsynchronousChannelProvider

java.lang.Object
  com.sun.sgs.nio.channels.spi.AsynchronousChannelProvider

Direct Known Subclasses:

AsyncProviderImpl

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.

If the system-wide default provider implements ManagedChannelFactory then the management interfaces for the pools of channels created by the provider will be included in the list of ChannelPoolMXBean objects returned by the Channels.getChannelPoolMXBeans() method [[NOT IMPLEMENTED: and also registered with the platform MBeanServer when the MBeanServer is obtained by invoking the ManagementFactory.getPlatformMBeanServer() method]]. To ensure that the ObjectName for uniquely identifying the ChannelPoolMXBean objects is unique it is recommended that the pool name is "asynchronous.name" where name identifies the provider's channel pool.

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

NOT IMPLEMENTED: openAsynchronousFileChannel

Constructor Summary

protected

AsynchronousChannelProvider() Initializes a new instance of this class.

Method Summary

abstract Thread.UncaughtExceptionHandler	getUncaughtExceptionHandler() Returns the uncaught exception handler for the default group.
abstract AsynchronousChannelGroup	openAsynchronousChannelGroup(ExecutorService executor) Constructs a new asynchronous channel group.
abstract AsynchronousDatagramChannel	openAsynchronousDatagramChannel(ProtocolFamily pf, AsynchronousChannelGroup group) Opens an asynchronous datagram channel.
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.
abstract void	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh) Set the uncaught exception handler for the default group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AsynchronousChannelProvider

protected AsynchronousChannelProvider()

Initializes a new instance of this class.

Throws:

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

Method Detail

provider

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 com.sun.sgs.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. [[NOT IMPLEMENTED: 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

openAsynchronousChannelGroup

public abstract AsynchronousChannelGroup openAsynchronousChannelGroup(ExecutorService executor)
                                                               throws IOException

Constructs a new asynchronous channel group.

Parameters:

executor - the executor service

Returns:

a new asynchronous channel group

Throws:

IOException - if an I/O error occurs

openAsynchronousServerSocketChannel

public abstract AsynchronousServerSocketChannel openAsynchronousServerSocketChannel(AsynchronousChannelGroup group)
                                                                             throws IOException

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:

IllegalArgumentException - if the provider that created the group differs from this provider

ShutdownChannelGroupException - if the group is shutdown

IOException - if an I/O error occurs

openAsynchronousSocketChannel

public abstract AsynchronousSocketChannel openAsynchronousSocketChannel(AsynchronousChannelGroup group)
                                                                 throws IOException

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:

IllegalArgumentException - if the provider that created the group differs from this provider

ShutdownChannelGroupException - if the group is shutdown

IOException - if an I/O error occurs

openAsynchronousDatagramChannel

public abstract AsynchronousDatagramChannel openAsynchronousDatagramChannel(ProtocolFamily pf,
                                                                            AsynchronousChannelGroup group)
                                                                     throws IOException

Opens an asynchronous datagram channel.

Parameters:

pf - the protocol family, or null for the default protocol family

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

Returns:

the new channel

Throws:

IllegalArgumentException - if the provider that created the group differs from this provider

ShutdownChannelGroupException - if the group is shutdown

IOException - if an I/O error occurs

setUncaughtExceptionHandler

public abstract void setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler eh)

Set the uncaught exception handler for the default group.

Parameters:

eh - the object to use as the default uncaught exception handler, or null for no default handler

Throws:

SecurityException - [TBD]

getUncaughtExceptionHandler

public abstract Thread.UncaughtExceptionHandler getUncaughtExceptionHandler()

Returns the uncaught exception handler for the default group.

Returns:

the uncaught exception handler for the default group, or null if there is no default handler