NIO2 API

org.classpath.icedtea.java.nio.channels.spi
Class AsynchronousChannelProvider

java.lang.Object
  extended by org.classpath.icedtea.java.nio.channels.spi.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.

Since:
1.7

Nested Class Summary
static class AsynchronousChannelProvider.ThreadPoolType
          The types of thread pool that an asynchronous channel group can be constructed with.
 
Constructor Summary
protected AsynchronousChannelProvider()
          Initializes a new instance of this class.
 
Method Summary
 AsynchronousChannelGroup openAsynchronousChannelGroup(AsynchronousChannelProvider.ThreadPoolType poolType, ExecutorService executor, int nThreads)
          Constructs a new asynchronous channel group.
abstract  AsynchronousDatagramChannel openAsynchronousDatagramChannel(ProtocolFamily family, 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.
 
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 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

openAsynchronousChannelGroup

public AsynchronousChannelGroup openAsynchronousChannelGroup(AsynchronousChannelProvider.ThreadPoolType poolType,
                                                             ExecutorService executor,
                                                             int nThreads)
                                                      throws IOException
Constructs a new asynchronous channel group.

Parameters:
poolType - The type of thread pool
executor - The thread pool
nThreads - The number of threads or initial size, depending on the thread pool type.
Throws:
IllegalArgumentException - If the nThreads parameter is invalid for the thread pool type
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:
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

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

openAsynchronousDatagramChannel

public abstract AsynchronousDatagramChannel openAsynchronousDatagramChannel(ProtocolFamily family,
                                                                            AsynchronousChannelGroup group)
                                                                     throws IOException
Opens an asynchronous datagram channel.

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

NIO2 API

Copyright © 2007, 2011, Oracle and/or its affiliates. All rights reserved.