XNIO API 3.8.13.Final · org.xnio.Xnio · APIdia, the JavaDoc alternative

Modifier and Type	Class and Description
pack-priv static class	Xnio.MBeanCloseable
pack-priv static class	Xnio.MBeanHolder
pack-priv static class	Xnio.OsgiSupport

Modifier and Type	Field and Description
private static final RuntimePermission	ALLOW_BLOCKING_SETTING
pack-priv static final InetSocketAddress	ANY_INET_ADDRESS
pack-priv static final LocalSocketAddress	ANY_LOCAL_ADDRESS
private static final ThreadLocal<Boolean>	BLOCKING
private static final EnumMap<FileAccess, OptionMap>	FILE_ACCESS_OPTION_MAPS
private final String	name The name of this provider instance.
public static final boolean	NIO2 A flag indicating the presence of NIO.2 (JDK 7).

Access	Constructor and Description
protected	Xnio(String the provider name name) Construct an XNIO provider instance.

Method Summary

Modifier and Type	Method and Description
public static boolean	Returns: the previous setting allowBlocking(boolean `true` to allow blocking I/O, `false` to disallow it newSetting) Allow (or disallow) blocking I/O on the current thread.
protected abstract XnioWorker	Returns: the constructed worker build(XnioWorker.Builder the builder (must not be `null`) builder) Construct an XNIO worker from a builder.
public static void	checkBlockingAllowed() Perform a check for whether blocking is allowed on the current thread.
public FileSystemWatcher	Returns: The file system watcher createFileSystemWatcher(final String The watcher name name, final OptionMap The options to use to create the watcher options) Creates a file system watcher, that can be used to monitor file system changes.
public XnioWorker	Returns: the new worker createWorker(OptionMap the options to use to configure the worker optionMap) Construct a new XNIO worker.
public XnioWorker	Returns: the new worker createWorker(ThreadGroup the thread group for worker threads threadGroup, OptionMap the options to use to configure the worker optionMap) Construct a new XNIO worker.
public XnioWorker	Returns: the new worker createWorker(ThreadGroup the thread group for worker threads threadGroup, OptionMap the options to use to configure the worker optionMap, Runnable the task to run after the worker has shut down terminationTask) Construct a new XNIO worker.
public XnioWorker.Builder	Returns: the worker builder (not `null`) createWorkerBuilder() Create a new worker builder.
private static synchronized Xnio	doGetInstance(final String provider, final ServiceLoader<XnioProvider> serviceLoader)
public static Xnio	Returns: the XNIO provider instance getInstance(final ClassLoader the class loader to search in classLoader) Get an XNIO provider instance.
public static Xnio	Returns: the XNIO provider instance getInstance() Get an XNIO provider instance from XNIO's class loader.
public static Xnio	Returns: the XNIO provider instance getInstance(String the provider name, or `null` for the first available provider, final ClassLoader the class loader to search in classLoader) Get a specific XNIO provider instance.
public static Xnio	Returns: the XNIO provider instance getInstance(String the provider name, or `null` for the first available provider) Get a specific XNIO provider instance from XNIO's class loader.
public final String	Returns: the name getName() Get the name of this XNIO provider.
protected static String	Returns: the property value, or `null` if it wasn't found getProperty(final String the property name name) Get an XNIO property.
protected static String	Returns: the property value, or `defaultValue` if it wasn't found getProperty(final String the property name name, final String the default value defaultValue) Get an XNIO property.
public XnioSsl	Returns: the SSL provider getSslProvider(final OptionMap the option map to use for configuring SSL optionMap) Get an SSL provider for this XNIO provider.
public XnioSsl	Returns: the SSL provider getSslProvider(final KeyManager[] the key managers to use, or `null` to configure from the option map keyManagers, final TrustManager[] the trust managers to use, or `null` to configure from the option map trustManagers, final OptionMap the option map to use for configuring SSL optionMap) Get an SSL provider for this XNIO provider.
protected void	handleThreadExit() Implement tasks that will be executed on thread exits if a task worker thread is initialized through `XnioWorker$WorkerThreadFactory`.
public static boolean	Returns: `true` if blocking I/O is allowed, `false` otherwise isBlockingAllowed() Determine whether blocking I/O is allowed from the current thread.
public FileChannel	Returns: the file channel openFile(File the file to open file, OptionMap the file-open options options) Open a file on the filesystem.
public FileChannel	Returns: the file channel openFile(String the file name of the file to open fileName, OptionMap the file-open options options) Open a file on the filesystem.
public FileChannel	Returns: the file channel openFile(File the file to open file, FileAccess the file access level to use access) Open a file on the filesystem.
public FileChannel	Returns: the file channel openFile(String the file name of the file to open fileName, FileAccess the file access level to use access) Open a file on the filesystem.
protected static Closeable	Returns: a handle which may be used to remove the registration register(XnioProviderMXBean the provider MBean to register providerMXBean) Register an MBean.
protected static Closeable	Returns: a handle which may be used to remove the registration register(XnioWorkerMXBean the worker MBean to register workerMXBean) Register an MBean.
protected static Closeable	Returns: a handle which may be used to remove the registration register(XnioServerMXBean the server MBean to register serverMXBean) Register an MBean.
public final String	Returns: the string representation toString() Overrides java.lang.Object.toString. Get a string representation of this XNIO provider.
protected FileChannel	Returns: the unwrapped file channel unwrapFileChannel(FileChannel the possibly wrapped file channel src) Unwrap an XNIO-wrapped file channel.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll wait wait wait

ALLOW_BLOCKING_SETTING	back to summary
private static final RuntimePermission ALLOW_BLOCKING_SETTING

ANY_INET_ADDRESS	back to summary
pack-priv static final InetSocketAddress ANY_INET_ADDRESS

ANY_LOCAL_ADDRESS	back to summary
pack-priv static final LocalSocketAddress ANY_LOCAL_ADDRESS

BLOCKING	back to summary
private static final ThreadLocal<Boolean> BLOCKING

FILE_ACCESS_OPTION_MAPS	back to summary
private static final EnumMap<FileAccess, OptionMap> FILE_ACCESS_OPTION_MAPS

name	back to summary
private final String name The name of this provider instance.

NIO2	back to summary
public static final boolean NIO2 A flag indicating the presence of NIO.2 (JDK 7). Always `true` as of XNIO version 3.5.0, which requires Java 8.

Xnio	back to summary
protected Xnio(String name) Construct an XNIO provider instance. Used by implementors only. To get an XNIO instance, use one of the `org.xnio.Xnio#getInstance()` methods. Parameters name:String the provider name

Method Detail

allowBlocking back to summary

allowBlocking	back to summary
public static boolean allowBlocking(boolean newSetting) throws SecurityException Allow (or disallow) blocking I/O on the current thread. Requires the `changeThreadBlockingSetting` `RuntimePermission`. Parameters newSetting:boolean `true` to allow blocking I/O, `false` to disallow it Returns:boolean the previous setting Exceptions SecurityException: if a security manager is present and disallows changing the `changeThreadBlockingSetting` `RuntimePermission`

public static boolean allowBlocking(boolean newSetting) throws SecurityException

Allow (or disallow) blocking I/O on the current thread. Requires the changeThreadBlockingSetting RuntimePermission.

Parameters

newSetting:boolean: true to allow blocking I/O, false to disallow it

Returns:boolean

the previous setting

Exceptions

SecurityException:: if a security manager is present and disallows changing the changeThreadBlockingSetting RuntimePermission

build back to summary

build	back to summary
protected abstract XnioWorker build(XnioWorker.Builder builder) Construct an XNIO worker from a builder. Parameters builder:XnioWorker.Builder the builder (must not be `null`) Returns:XnioWorker the constructed worker

protected abstract XnioWorker build(XnioWorker.Builder builder)

Construct an XNIO worker from a builder.

Parameters

builder:XnioWorker.Builder: the builder (must not be null)

Returns:XnioWorker

the constructed worker

checkBlockingAllowed	back to summary
public static void checkBlockingAllowed() throws IllegalStateException Perform a check for whether blocking is allowed on the current thread. Exceptions IllegalStateException: if blocking is not allowed on the current thread

checkBlockingAllowed

back to summary

public static void checkBlockingAllowed() throws IllegalStateException

Perform a check for whether blocking is allowed on the current thread.

Exceptions

IllegalStateException:: if blocking is not allowed on the current thread

createFileSystemWatcher	back to summary
public FileSystemWatcher createFileSystemWatcher(final String name, final OptionMap options) Creates a file system watcher, that can be used to monitor file system changes. Parameters name:String The watcher name options:OptionMap The options to use to create the watcher Returns:FileSystemWatcher The file system watcher

createFileSystemWatcher

back to summary

public FileSystemWatcher createFileSystemWatcher(final String name, final OptionMap options)

Creates a file system watcher, that can be used to monitor file system changes.

Parameters

name:String: The watcher name
options:OptionMap: The options to use to create the watcher

Returns:FileSystemWatcher

The file system watcher

createWorker	back to summary
public XnioWorker createWorker(OptionMap optionMap) throws IOException, IllegalArgumentException Construct a new XNIO worker. Parameters optionMap:OptionMap the options to use to configure the worker Returns:XnioWorker the new worker Exceptions IOException: if the worker failed to be opened IllegalArgumentException: if an option value is invalid for this worker

createWorker

back to summary

public XnioWorker createWorker(OptionMap optionMap) throws IOException, IllegalArgumentException

Construct a new XNIO worker.

Parameters

optionMap:OptionMap: the options to use to configure the worker

Returns:XnioWorker

the new worker

Exceptions

IOException:: if the worker failed to be opened
IllegalArgumentException:: if an option value is invalid for this worker

createWorker	back to summary
public XnioWorker createWorker(ThreadGroup threadGroup, OptionMap optionMap) throws IOException, IllegalArgumentException Construct a new XNIO worker. Parameters threadGroup:ThreadGroup the thread group for worker threads optionMap:OptionMap the options to use to configure the worker Returns:XnioWorker the new worker Exceptions IOException: if the worker failed to be opened IllegalArgumentException: if an option value is invalid for this worker

createWorker

back to summary

public XnioWorker createWorker(ThreadGroup threadGroup, OptionMap optionMap) throws IOException, IllegalArgumentException

Construct a new XNIO worker.

Parameters

threadGroup:ThreadGroup: the thread group for worker threads
optionMap:OptionMap: the options to use to configure the worker

Returns:XnioWorker

the new worker

Exceptions

IOException:: if the worker failed to be opened
IllegalArgumentException:: if an option value is invalid for this worker

createWorker	back to summary
public XnioWorker createWorker(ThreadGroup threadGroup, OptionMap optionMap, Runnable terminationTask) throws IOException, IllegalArgumentException Construct a new XNIO worker. Parameters threadGroup:ThreadGroup the thread group for worker threads optionMap:OptionMap the options to use to configure the worker terminationTask:Runnable the task to run after the worker has shut down Returns:XnioWorker the new worker Exceptions IOException: if the worker failed to be opened IllegalArgumentException: if an option value is invalid for this worker

createWorker

back to summary

public XnioWorker createWorker(ThreadGroup threadGroup, OptionMap optionMap, Runnable terminationTask) throws IOException, IllegalArgumentException

Construct a new XNIO worker.

Parameters

threadGroup:ThreadGroup: the thread group for worker threads
optionMap:OptionMap: the options to use to configure the worker
terminationTask:Runnable: the task to run after the worker has shut down

Returns:XnioWorker

the new worker

Exceptions

IOException:: if the worker failed to be opened
IllegalArgumentException:: if an option value is invalid for this worker

createWorkerBuilder back to summary

createWorkerBuilder	back to summary
public XnioWorker.Builder createWorkerBuilder() Create a new worker builder. Returns:XnioWorker.Builder the worker builder (not `null`)

public XnioWorker.Builder createWorkerBuilder()

Create a new worker builder.

Returns:XnioWorker.Builder: the worker builder (not null)

doGetInstance	back to summary
private static synchronized Xnio doGetInstance(final String provider, final ServiceLoader<XnioProvider> serviceLoader)

getInstance	back to summary
public static Xnio getInstance(final ClassLoader classLoader) Get an XNIO provider instance. If multiple providers are available, use the first one encountered. Parameters classLoader:ClassLoader the class loader to search in Returns:Xnio the XNIO provider instance Since 3.0

getInstance

back to summary

public static Xnio getInstance(final ClassLoader classLoader)

Get an XNIO provider instance. If multiple providers are available, use the first one encountered.

Parameters

classLoader:ClassLoader: the class loader to search in

Returns:Xnio

the XNIO provider instance

Since

3.0

getInstance	back to summary
public static Xnio getInstance() Get an XNIO provider instance from XNIO's class loader. If multiple providers are available, use the first one encountered. Returns:Xnio the XNIO provider instance Since 3.0

getInstance

back to summary

public static Xnio getInstance()

Get an XNIO provider instance from XNIO's class loader. If multiple providers are available, use the first one encountered.

Returns:Xnio: the XNIO provider instance
Since: 3.0

getInstance back to summary

getInstance	back to summary
public static Xnio getInstance(String provider, final ClassLoader classLoader) Get a specific XNIO provider instance. Parameters provider:String the provider name, or `null` for the first available classLoader:ClassLoader the class loader to search in Returns:Xnio the XNIO provider instance Since 3.0

public static Xnio getInstance(String provider, final ClassLoader classLoader)

Get a specific XNIO provider instance.

Parameters

provider:String: the provider name, or null for the first available
classLoader:ClassLoader: the class loader to search in

Returns:Xnio

the XNIO provider instance

Since

3.0

getInstance back to summary

getInstance	back to summary
public static Xnio getInstance(String provider) Get a specific XNIO provider instance from XNIO's class loader. Parameters provider:String the provider name, or `null` for the first available Returns:Xnio the XNIO provider instance Since 3.0

public static Xnio getInstance(String provider)

Get a specific XNIO provider instance from XNIO's class loader.

Parameters

provider:String: the provider name, or null for the first available

Returns:Xnio

the XNIO provider instance

Since

3.0

getName	back to summary
public final String getName() Get the name of this XNIO provider. Returns:String the name

getName

back to summary

public final String getName()

Get the name of this XNIO provider.

Returns:String: the name

getProperty back to summary

getProperty	back to summary
protected static String getProperty(final String name) Get an XNIO property. The property name must start with `"xnio."`. Parameters name:String the property name Returns:String the property value, or `null` if it wasn't found Since 1.2

protected static String getProperty(final String name)

Get an XNIO property. The property name must start with "xnio.".

Parameters

name:String: the property name

Returns:String

the property value, or null if it wasn't found

Since

1.2

getProperty back to summary

getProperty	back to summary
protected static String getProperty(final String name, final String defaultValue) Get an XNIO property. The property name must start with `"xnio."`. Parameters name:String the property name defaultValue:String the default value Returns:String the property value, or `defaultValue` if it wasn't found Since 1.2

protected static String getProperty(final String name, final String defaultValue)

Get an XNIO property. The property name must start with "xnio.".

Parameters

name:String: the property name
defaultValue:String: the default value

Returns:String

the property value, or defaultValue if it wasn't found

Since

1.2

getSslProvider	back to summary
public XnioSsl getSslProvider(final OptionMap optionMap) throws GeneralSecurityException Get an SSL provider for this XNIO provider. Parameters optionMap:OptionMap the option map to use for configuring SSL Returns:XnioSsl the SSL provider Exceptions GeneralSecurityException: if an exception occurred configuring the SSL provider

getSslProvider

back to summary

public XnioSsl getSslProvider(final OptionMap optionMap) throws GeneralSecurityException

Get an SSL provider for this XNIO provider.

Parameters

optionMap:OptionMap: the option map to use for configuring SSL

Returns:XnioSsl

the SSL provider

Exceptions

GeneralSecurityException:: if an exception occurred configuring the SSL provider

getSslProvider back to summary

getSslProvider	back to summary
public XnioSsl getSslProvider(final KeyManager[] keyManagers, final TrustManager[] trustManagers, final OptionMap optionMap) throws GeneralSecurityException Get an SSL provider for this XNIO provider. Parameters keyManagers:KeyManager[] the key managers to use, or `null` to configure from the option map trustManagers:TrustManager[] the trust managers to use, or `null` to configure from the option map optionMap:OptionMap the option map to use for configuring SSL Returns:XnioSsl the SSL provider Exceptions GeneralSecurityException: if an exception occurred configuring the SSL provider

public XnioSsl getSslProvider(final KeyManager[] keyManagers, final TrustManager[] trustManagers, final OptionMap optionMap) throws GeneralSecurityException

Get an SSL provider for this XNIO provider.

Parameters

keyManagers:KeyManager[]: the key managers to use, or null to configure from the option map
trustManagers:TrustManager[]: the trust managers to use, or null to configure from the option map
optionMap:OptionMap: the option map to use for configuring SSL

Returns:XnioSsl

the SSL provider

Exceptions

GeneralSecurityException:: if an exception occurred configuring the SSL provider

handleThreadExit	back to summary
protected void handleThreadExit() Implement tasks that will be executed on thread exits if a task worker thread is initialized through `XnioWorker$WorkerThreadFactory`.

isBlockingAllowed back to summary

isBlockingAllowed	back to summary
public static boolean isBlockingAllowed() Determine whether blocking I/O is allowed from the current thread. Returns:boolean `true` if blocking I/O is allowed, `false` otherwise

public static boolean isBlockingAllowed()

Determine whether blocking I/O is allowed from the current thread.

Returns:boolean: true if blocking I/O is allowed, false otherwise

openFile	back to summary
public FileChannel openFile(File file, OptionMap options) throws IOException Open a file on the filesystem. Parameters file:File the file to open options:OptionMap the file-open options Returns:FileChannel the file channel Exceptions IOException: if an I/O error occurs

openFile

back to summary

public FileChannel openFile(File file, OptionMap options) throws IOException

Open a file on the filesystem.

Parameters

file:File: the file to open
options:OptionMap: the file-open options

Returns:FileChannel

the file channel

Exceptions

IOException:: if an I/O error occurs

openFile	back to summary
public FileChannel openFile(String fileName, OptionMap options) throws IOException Open a file on the filesystem. Parameters fileName:String the file name of the file to open options:OptionMap the file-open options Returns:FileChannel the file channel Exceptions IOException: if an I/O error occurs

openFile

back to summary

public FileChannel openFile(String fileName, OptionMap options) throws IOException

Open a file on the filesystem.

Parameters

fileName:String: the file name of the file to open
options:OptionMap: the file-open options

Returns:FileChannel

the file channel

Exceptions

IOException:: if an I/O error occurs

openFile	back to summary
public FileChannel openFile(File file, FileAccess access) throws IOException Open a file on the filesystem. Parameters file:File the file to open access:FileAccess the file access level to use Returns:FileChannel the file channel Exceptions IOException: if an I/O error occurs

openFile

back to summary

public FileChannel openFile(File file, FileAccess access) throws IOException

Open a file on the filesystem.

Parameters

file:File: the file to open
access:FileAccess: the file access level to use

Returns:FileChannel

the file channel

Exceptions

IOException:: if an I/O error occurs

openFile	back to summary
public FileChannel openFile(String fileName, FileAccess access) throws IOException Open a file on the filesystem. Parameters fileName:String the file name of the file to open access:FileAccess the file access level to use Returns:FileChannel the file channel Exceptions IOException: if an I/O error occurs

openFile

back to summary

public FileChannel openFile(String fileName, FileAccess access) throws IOException

Open a file on the filesystem.

Parameters

fileName:String: the file name of the file to open
access:FileAccess: the file access level to use

Returns:FileChannel

the file channel

Exceptions

IOException:: if an I/O error occurs

register	back to summary
protected static Closeable register(XnioProviderMXBean providerMXBean) Register an MBean. If the MBean cannot be registered, this method will simply return. Parameters providerMXBean:XnioProviderMXBean the provider MBean to register Returns:Closeable a handle which may be used to remove the registration

back to summary

protected static Closeable register(XnioProviderMXBean providerMXBean)

Parameters

providerMXBean:XnioProviderMXBean: the provider MBean to register

Returns:Closeable

a handle which may be used to remove the registration

register	back to summary
protected static Closeable register(XnioWorkerMXBean workerMXBean) Register an MBean. If the MBean cannot be registered, this method will simply return. Parameters workerMXBean:XnioWorkerMXBean the worker MBean to register Returns:Closeable a handle which may be used to remove the registration

back to summary

protected static Closeable register(XnioWorkerMXBean workerMXBean)

Parameters

workerMXBean:XnioWorkerMXBean: the worker MBean to register

Returns:Closeable

a handle which may be used to remove the registration

register	back to summary
protected static Closeable register(XnioServerMXBean serverMXBean) Register an MBean. If the MBean cannot be registered, this method will simply return. Parameters serverMXBean:XnioServerMXBean the server MBean to register Returns:Closeable a handle which may be used to remove the registration

back to summary

protected static Closeable register(XnioServerMXBean serverMXBean)

Parameters

serverMXBean:XnioServerMXBean: the server MBean to register

Returns:Closeable

a handle which may be used to remove the registration

toString	back to summary
public final String toString() Overrides java.lang.Object.toString. Get a string representation of this XNIO provider. Returns:String the string representation

toString

back to summary

public final String toString()

Overrides java.lang.Object.toString.

Get a string representation of this XNIO provider.

Returns:String: the string representation

unwrapFileChannel	back to summary
protected FileChannel unwrapFileChannel(FileChannel src) Unwrap an XNIO-wrapped file channel. For use by providers. Parameters src:FileChannel the possibly wrapped file channel Returns:FileChannel the unwrapped file channel

unwrapFileChannel

back to summary

protected FileChannel unwrapFileChannel(FileChannel src)

Unwrap an XNIO-wrapped file channel. For use by providers.

Parameters

src:FileChannel: the possibly wrapped file channel

Returns:FileChannel

the unwrapped file channel

public abstract Class Xnio

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class Xnio.MBeanCloseable

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class Xnio.MBeanHolder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

pack-priv Class Xnio.OsgiSupport

Constructor Summary

Method Summary

Constructor Detail

Method Detail