AsynchronousChannelProvider
abstract class AsynchronousChannelProvider
| kotlin.Any | |
| ↳ | 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 | |
|---|---|
|
Initializes a new instance of this class. |
|
| Public methods | |
|---|---|
| abstract AsynchronousChannelGroup! |
openAsynchronousChannelGroup(nThreads: Int, threadFactory: ThreadFactory!)Constructs a new asynchronous channel group with a fixed thread pool. |
| abstract AsynchronousChannelGroup! |
openAsynchronousChannelGroup(executor: ExecutorService!, initialSize: Int)Constructs a new asynchronous channel group with the given thread pool. |
| abstract AsynchronousServerSocketChannel! |
Opens an asynchronous server-socket channel. |
| abstract AsynchronousSocketChannel! |
Opens an asynchronous socket channel. |
| open static AsynchronousChannelProvider! |
provider()Returns the system-wide default asynchronous channel provider for this invocation of the Java virtual machine. |
Protected constructors
AsynchronousChannelProvider
protected AsynchronousChannelProvider()
Initializes a new instance of this class.
| Exceptions | |
|---|---|
java.lang.SecurityException |
If a security manager has been installed and it denies RuntimePermission("asynchronousChannelProvider") |
Public methods
openAsynchronousChannelGroup
abstract fun openAsynchronousChannelGroup(
nThreads: Int,
threadFactory: ThreadFactory!
): AsynchronousChannelGroup!
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 |
| Return | |
|---|---|
AsynchronousChannelGroup! |
A new asynchronous channel group |
| Exceptions | |
|---|---|
java.lang.IllegalArgumentException |
If nThreads <= 0 |
java.io.IOException |
If an I/O error occurs |
openAsynchronousChannelGroup
abstract fun openAsynchronousChannelGroup(
executor: ExecutorService!,
initialSize: Int
): AsynchronousChannelGroup!
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 |
| Return | |
|---|---|
AsynchronousChannelGroup! |
A new asynchronous channel group |
| Exceptions | |
|---|---|
java.io.IOException |
If an I/O error occurs |
openAsynchronousServerSocketChannel
abstract fun openAsynchronousServerSocketChannel(group: AsynchronousChannelGroup!): AsynchronousServerSocketChannel!
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 |
| Return | |
|---|---|
AsynchronousServerSocketChannel! |
The new channel |
| Exceptions | |
|---|---|
java.nio.channels.IllegalChannelGroupException |
If the provider that created the group differs from this provider |
java.nio.channels.ShutdownChannelGroupException |
The group is shutdown |
java.io.IOException |
If an I/O error occurs |
openAsynchronousSocketChannel
abstract fun openAsynchronousSocketChannel(group: AsynchronousChannelGroup!): AsynchronousSocketChannel!
Opens an asynchronous socket channel.
| Parameters | |
|---|---|
group |
AsynchronousChannelGroup!: The group to which the channel is bound, or null to bind to the default group |
| Return | |
|---|---|
AsynchronousSocketChannel! |
The new channel |
| Exceptions | |
|---|---|
java.nio.channels.IllegalChannelGroupException |
If the provider that created the group differs from this provider |
java.nio.channels.ShutdownChannelGroupException |
The group is shutdown |
java.io.IOException |
If an I/O error occurs |
provider
open static fun provider(): AsynchronousChannelProvider!
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:
- If the system property
java.nio.channels.spi.AsynchronousChannelProvideris 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. - 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.AsynchronousChannelProviderin the resource directoryMETA-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. - 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.
| Return | |
|---|---|
AsynchronousChannelProvider! |
The system-wide default AsynchronousChannel provider |