Uses of Class
org.xnio.Option

Packages that use Option

Package	Description
org.xnio	The main API package for XNIO.
org.xnio.channels	The core XNIO channel API.
org.xnio.conduits	The XNIO conduit SPI.
org.xnio.ssl	Utility classes for using and implementing SSL within XNIO providers.

Uses of Option in org.xnio

Fields in org.xnio declared as Option

Modifier and Type	Field	Description
static Option<java.lang.Boolean>	Options.ALLOW_BLOCKING	Enable or disable blocking I/O for a newly created channel thread.
static Option<java.lang.Integer>	Options.BACKLOG	Configure a server with the specified backlog.
static Option<java.lang.Integer>	Options.BALANCING_CONNECTIONS	The number of connections to create per connection-balancing token, if connection-balancing is enabled.
static Option<java.lang.Integer>	Options.BALANCING_TOKENS	The number of balancing tokens, if connection-balancing is enabled.
static Option<java.lang.Boolean>	Options.BROADCAST	Enable broadcast support for IP datagram sockets.
static Option<java.lang.Boolean>	Options.CLOSE_ABORT	Configure a TCP socket to send an RST packet on close.
static Option<java.lang.Integer>	Options.COMPRESSION_LEVEL	The compression level to apply for compressing streams and channels.
static Option<CompressionType>	Options.COMPRESSION_TYPE	The compression type to apply for compressing streams and channels.
static Option<java.lang.Integer>	Options.CONNECTION_HIGH_WATER	The high water mark for a server's connections.
static Option<java.lang.Integer>	Options.CONNECTION_LOW_WATER	The low water mark for a server's connections.
static Option<java.lang.Boolean>	Options.CORK	Specify that output should be buffered.
static Option<FileAccess>	Options.FILE_ACCESS	The file access mode to use when opening a file.
static Option<java.lang.Boolean>	Options.FILE_APPEND	A flag which indicates that opened files should be appended to.
static Option<java.lang.Boolean>	Options.FILE_CREATE	A flag which indicates that a file should be created if it does not exist (true by default for writing files, false by default for reading files).
static Option<java.lang.Integer>	Options.IP_TRAFFIC_CLASS	Set the IP traffic class/type-of-service for the channel.
static Option<java.lang.Boolean>	Options.KEEP_ALIVE	Configure a channel to send TCP keep-alive messages in an implementation-dependent manner.
static Option<java.lang.Integer>	Options.MAX_INBOUND_MESSAGE_SIZE	The maximum inbound message size.
static Option<java.lang.Integer>	Options.MAX_OUTBOUND_MESSAGE_SIZE	The maximum outbound message size.
static Option<java.lang.Boolean>	Options.MULTICAST	Enable multicast support for a socket.
static Option<java.lang.Integer>	Options.MULTICAST_TTL	Set the multicast time-to-live field for datagram sockets.
static Option<java.lang.Integer>	Options.READ_TIMEOUT	Configure a read timeout for a socket, in milliseconds.
static Option<java.lang.Integer>	Options.RECEIVE_BUFFER	The receive buffer size.
static Option<java.lang.Boolean>	Options.REUSE_ADDRESSES	Configure an IP socket to reuse addresses.
static Option<Sequence<java.lang.String>>	Options.SASL_DISALLOWED_MECHANISMS	A list of disallowed SASL mechanisms.
static Option<Sequence<java.lang.String>>	Options.SASL_MECHANISMS	A list of SASL mechanisms, in decreasing order of preference.
static Option<java.lang.Boolean>	Options.SASL_POLICY_FORWARD_SECRECY	Specify whether SASL mechanisms which implement forward secrecy between sessions are required.
static Option<java.lang.Boolean>	Options.SASL_POLICY_NOACTIVE	Specify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.
static Option<java.lang.Boolean>	Options.SASL_POLICY_NOANONYMOUS	Specify whether SASL mechanisms which accept anonymous logins are permitted.
static Option<java.lang.Boolean>	Options.SASL_POLICY_NODICTIONARY	Specify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.
static Option<java.lang.Boolean>	Options.SASL_POLICY_NOPLAINTEXT	Specify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.
static Option<java.lang.Boolean>	Options.SASL_POLICY_PASS_CREDENTIALS	Specify whether SASL mechanisms which pass client credentials are required.
static Option<Sequence<Property>>	Options.SASL_PROPERTIES	A list of provider specific SASL properties.
static Option<Sequence<SaslQop>>	Options.SASL_QOP	Specify the SASL quality-of-protection to use.
static Option<java.lang.Boolean>	Options.SASL_REUSE	Specify whether SASL mechanisms should attempt to reuse authenticated session information.
static Option<java.lang.Boolean>	Options.SASL_SERVER_AUTH	Specify whether the SASL server must authenticate to the client.
static Option<SaslStrength>	Options.SASL_STRENGTH	Specify the SASL cipher strength to use.
static Option<java.lang.Boolean>	Options.SECURE	Determine whether the channel is encrypted, or employs some other level of security.
static Option<java.lang.Integer>	Options.SEND_BUFFER	The send buffer size.
static Option<java.lang.Boolean>	Options.SPLIT_READ_WRITE_THREADS	Specify whether read and write operations should be split among separate threads.
static Option<java.lang.Integer>	Options.SSL_APPLICATION_BUFFER_REGION_SIZE	The size of the allocation region to use for SSL application buffers.
static Option<java.lang.Integer>	Options.SSL_APPLICATION_BUFFER_SIZE	The application buffer size for SSL.
static Option<SslClientAuthMode>	Options.SSL_CLIENT_AUTH_MODE	Specify the SSL client authentication mode.
static Option<java.lang.Integer>	Options.SSL_CLIENT_SESSION_CACHE_SIZE	The size of the SSL client session cache.
static Option<java.lang.Integer>	Options.SSL_CLIENT_SESSION_TIMEOUT	The SSL client session timeout (in seconds).
static Option<java.lang.Boolean>	Options.SSL_ENABLE_SESSION_CREATION	Enable or disable session creation for an SSL connection.
static Option<java.lang.Boolean>	Options.SSL_ENABLED	Specify whether SSL should be enabled.
static Option<Sequence<java.lang.String>>	Options.SSL_ENABLED_CIPHER_SUITES	Specify the cipher suites for an SSL/TLS session.
static Option<Sequence<java.lang.String>>	Options.SSL_ENABLED_PROTOCOLS	Specify the enabled protocols for an SSL/TLS session.
static Option<Sequence<java.lang.Class<? extends javax.net.ssl.KeyManager>>>	Options.SSL_JSSE_KEY_MANAGER_CLASSES	The possible key manager classes to use for a JSSE SSL context.
static Option<Sequence<java.lang.Class<? extends javax.net.ssl.TrustManager>>>	Options.SSL_JSSE_TRUST_MANAGER_CLASSES	The possible trust store classes to use for a JSSE SSL context.
static Option<java.lang.Boolean>	Options.SSL_NON_BLOCKING_KEY_MANAGER	Hint to the SSL engine that the key manager implementation(s) is/are non-blocking, so they can be executed in the I/O thread, possibly improving performance by decreasing latency.
static Option<java.lang.Boolean>	Options.SSL_NON_BLOCKING_TRUST_MANAGER	Hint to the SSL engine that the trust manager implementation(s) is/are non-blocking, so they can be executed in the I/O thread, possibly improving performance by decreasing latency.
static Option<java.lang.Integer>	Options.SSL_PACKET_BUFFER_REGION_SIZE	The size of the allocation region to use for SSL packet buffers.
static Option<java.lang.Integer>	Options.SSL_PACKET_BUFFER_SIZE	The packet buffer size for SSL.
static Option<java.lang.String>	Options.SSL_PEER_HOST_NAME	Specify the (non-authoritative) name of the peer host to use for the purposes of session reuse, as well as for the use of certain cipher suites (such as Kerberos).
static Option<java.lang.Integer>	Options.SSL_PEER_PORT	Specify the (non-authoritative) port number of the peer port number to use for the purposes of session reuse, as well as for the use of certain cipher suites.
static Option<java.lang.String>	Options.SSL_PROTOCOL	Specify the protocol name for an SSL context.
static Option<java.lang.String>	Options.SSL_PROVIDER	Specify the requested provider for an SSL/TLS session.
static Option<OptionMap>	Options.SSL_RNG_OPTIONS	The configuration of a secure RNG for SSL usage.
static Option<java.lang.Integer>	Options.SSL_SERVER_SESSION_CACHE_SIZE	The size of the SSL server session cache.
static Option<java.lang.Integer>	Options.SSL_SERVER_SESSION_TIMEOUT	The SSL server session timeout (in seconds).
static Option<java.lang.Boolean>	Options.SSL_STARTTLS	Specify whether to use STARTTLS mode (in which a connection starts clear and switches to TLS on demand).
static Option<Sequence<java.lang.String>>	Options.SSL_SUPPORTED_CIPHER_SUITES	Get the supported cipher suites for an SSL/TLS session.
static Option<Sequence<java.lang.String>>	Options.SSL_SUPPORTED_PROTOCOLS	Get the supported protocols for an SSL/TLS session.
static Option<java.lang.Boolean>	Options.SSL_USE_CLIENT_MODE	Specify whether SSL conversations should be in client or server mode.
static Option<java.lang.Long>	Options.STACK_SIZE	The stack size (in bytes) to attempt to use for worker threads.
static Option<java.lang.Boolean>	Options.TCP_NODELAY	Configure a TCP socket to disable Nagle's algorithm.
static Option<java.lang.Boolean>	Options.TCP_OOB_INLINE	Configure a TCP socket to receive out-of-band data alongside regular data.
static Option<java.lang.Boolean>	Options.THREAD_DAEMON	Specify whether worker threads should be daemon threads.
static Option<java.lang.Integer>	Options.THREAD_PRIORITY	The thread priority for newly created worker threads.
static Option<java.lang.Boolean>	Options.USE_DIRECT_BUFFERS	Specify whether direct buffers should be used for socket communications.
static Option<java.lang.Integer>	Options.WATCHER_POLL_INTERVAL	The poll interval for poll based file system watchers.
static Option<java.lang.Integer>	Options.WORKER_ACCEPT_THREADS	Deprecated. This option is now ignored.
static Option<java.lang.Boolean>	Options.WORKER_ESTABLISH_WRITING	Specify whether a server, acceptor, or connector should be attached to write threads.
static Option<java.lang.Integer>	Options.WORKER_IO_THREADS	Specify the number of I/O threads to create for the worker.
static Option<java.lang.String>	Options.WORKER_NAME	The name to use for a newly created worker.
static Option<java.lang.Integer>	Options.WORKER_READ_THREADS	Specify the number of I/O threads to devote to reading for split thread channels.
static Option<java.lang.Integer>	Options.WORKER_TASK_CORE_THREADS	Specify the number of "core" threads for the worker task thread pool.
static Option<java.lang.Integer>	Options.WORKER_TASK_KEEPALIVE	Specify the number of milliseconds to keep non-core task threads alive.
static Option<java.lang.Integer>	Options.WORKER_TASK_LIMIT	Specify the maximum number of worker tasks to allow before rejecting.
static Option<java.lang.Integer>	Options.WORKER_TASK_MAX_THREADS	Specify the maximum number of threads for the worker task thread pool.
static Option<java.lang.Integer>	Options.WORKER_WRITE_THREADS	Specify the number of I/O threads to devote to writing for split thread channels.
static Option<java.lang.Integer>	Options.WRITE_TIMEOUT	Configure a write timeout for a socket, in milliseconds.

Methods in org.xnio that return Option

Modifier and Type	Method	Description
static Option<?>	Option.fromString(java.lang.String name, java.lang.ClassLoader classLoader)	Get an option from a string name, using the given classloader.
static <T> Option<Sequence<T>>	Option.sequence(java.lang.Class<?> declClass, java.lang.String name, java.lang.Class<T> elementType)	Create an option with a sequence type.
static <T> Option<T>	Option.simple(java.lang.Class<?> declClass, java.lang.String name, java.lang.Class<T> type)	Create an option with a simple type.
static <T> Option<java.lang.Class<? extends T>>	Option.type(java.lang.Class<?> declClass, java.lang.String name, java.lang.Class<T> declType)	Create an option with a class type.
static <T> Option<Sequence<java.lang.Class<? extends T>>>	Option.typeSequence(java.lang.Class<?> declClass, java.lang.String name, java.lang.Class<T> elementDeclType)	Create an option with a sequence-of-types type.

Methods in org.xnio that return types with arguments of type Option

Modifier and Type	Method	Description
java.util.Set<Option<?>>	Option.SetBuilder.create()	Create the immutable option set instance.
java.util.Iterator<Option<?>>	OptionMap.iterator()	Iterate over the options in this map.

Methods in org.xnio with parameters of type Option

Modifier and Type	Method	Description
Option.SetBuilder	Option.SetBuilder.add(Option<?> option)	Add an option to this set.
Option.SetBuilder	Option.SetBuilder.add(Option<?>... options)	Add options to this set.
Option.SetBuilder	Option.SetBuilder.add(Option<?> option1, Option<?> option2)	Add options to this set.
Option.SetBuilder	Option.SetBuilder.add(Option<?> option1, Option<?> option2, Option<?> option3)	Add options to this set.
boolean	OptionMap.contains(Option<?> option)	Determine whether this option map contains the given option.
static <T> OptionMap	OptionMap.create(Option<T> option, T value)	Create a single-valued option map.
static <T1,T2> OptionMap	OptionMap.create(Option<T1> option1, T1 value1, Option<T2> option2, T2 value2)	Create a two-valued option map.
boolean	OptionMap.get(Option<java.lang.Boolean> option, boolean defaultValue)	Get a boolean value from this option map, with a specified default if the value is missing.
int	OptionMap.get(Option<java.lang.Integer> option, int defaultValue)	Get a int value from this option map, with a specified default if the value is missing.
long	OptionMap.get(Option<java.lang.Long> option, long defaultValue)	Get a long value from this option map, with a specified default if the value is missing.
<T> T	OptionMap.get(Option<T> option)	Get the value of an option from this option map.
<T> T	OptionMap.get(Option<T> option, T defaultValue)	Get the value of an option from this option map, with a specified default if the value is missing.
<T> T	Connection.getOption(Option<T> option)
<T> T	XnioWorker.getOption(Option<T> option)
<T> OptionMap.Builder	OptionMap.Builder.parse(Option<T> key, java.lang.String stringValue)	Set a key-value pair, parsing the value from the given string.
<T> OptionMap.Builder	OptionMap.Builder.parse(Option<T> key, java.lang.String stringValue, java.lang.ClassLoader classLoader)	Set a key-value pair, parsing the value from the given string.
OptionMap.Builder	OptionMap.Builder.set(Option<java.lang.Boolean> key, boolean value)	Set a boolean value for a Boolean key.
OptionMap.Builder	OptionMap.Builder.set(Option<java.lang.Integer> key, int value)	Set an int value for an Integer key.
OptionMap.Builder	OptionMap.Builder.set(Option<java.lang.Long> key, long value)	Set a long value for a Long key.
<T> OptionMap.Builder	OptionMap.Builder.set(Option<T> key, T value)	Set a key-value pair.
<T> T	Connection.setOption(Option<T> option, T value)
<T> T	XnioWorker.setOption(Option<T> option, T value)
OptionMap.Builder	OptionMap.Builder.setSequence(Option<Sequence<java.lang.Boolean>> key, boolean... values)	Set boolean values for an Boolean sequence key.
OptionMap.Builder	OptionMap.Builder.setSequence(Option<Sequence<java.lang.Integer>> key, int... values)	Set int values for an Integer sequence key.
OptionMap.Builder	OptionMap.Builder.setSequence(Option<Sequence<java.lang.Long>> key, long... values)	Set long values for a Long sequence key.
<T> OptionMap.Builder	OptionMap.Builder.setSequence(Option<Sequence<T>> key, T... values)	Set a key-value pair, where the value is a sequence type.
boolean	Connection.supportsOption(Option<?> option)
boolean	XnioWorker.supportsOption(Option<?> option)

Method parameters in org.xnio with type arguments of type Option

Modifier and Type	Method	Description
Option.SetBuilder	Option.SetBuilder.addAll(java.util.Collection<Option<?>> options)	Add all options from a collection to this set.

Uses of Option in org.xnio.channels

Methods in org.xnio.channels with parameters of type Option

Modifier and Type	Method	Description
<T> T	AssembledChannel.getOption(Option<T> option)
<T> T	AssembledMessageChannel.getOption(Option<T> option)
<T> T	AssembledStreamChannel.getOption(Option<T> option)
static boolean	Channels.getOption(Configurable configurable, Option<java.lang.Boolean> option, boolean defaultValue)	Get an option value from a configurable target.
static int	Channels.getOption(Configurable configurable, Option<java.lang.Integer> option, int defaultValue)	Get an option value from a configurable target.
static long	Channels.getOption(Configurable configurable, Option<java.lang.Long> option, long defaultValue)	Get an option value from a configurable target.
static <T> T	Channels.getOption(Configurable configurable, Option<T> option, T defaultValue)	Get an option value from a configurable target.
<T> T	Configurable.getOption(Option<T> option)	Get the value of a channel option.
<T> T	EmptyStreamSourceChannel.getOption(Option<T> option)
<T> T	FixedLengthStreamSinkChannel.getOption(Option<T> option)
<T> T	FixedLengthStreamSourceChannel.getOption(Option<T> option)
<T> T	NullStreamSinkChannel.getOption(Option<T> option)
<T> T	PushBackStreamChannel.getOption(Option<T> option)
<T> T	SplitStreamSinkChannel.getOption(Option<T> option)
<T> T	SplitStreamSourceChannel.getOption(Option<T> option)
<T> T	TranslatingSuspendableChannel.getOption(Option<T> option)	Deprecated. Get the value of a channel option.
<T> T	AssembledChannel.setOption(Option<T> option, T value)
<T> T	AssembledMessageChannel.setOption(Option<T> option, T value)
<T> T	AssembledStreamChannel.setOption(Option<T> option, T value)
<T> T	Configurable.setOption(Option<T> option, T value)	Set an option for this channel.
<T> T	EmptyStreamSourceChannel.setOption(Option<T> option, T value)
<T> T	FixedLengthStreamSinkChannel.setOption(Option<T> option, T value)
<T> T	FixedLengthStreamSourceChannel.setOption(Option<T> option, T value)
<T> T	NullStreamSinkChannel.setOption(Option<T> option, T value)
<T> T	PushBackStreamChannel.setOption(Option<T> option, T value)
<T> T	SplitStreamSinkChannel.setOption(Option<T> option, T value)
<T> T	SplitStreamSourceChannel.setOption(Option<T> option, T value)
<T> T	TranslatingSuspendableChannel.setOption(Option<T> option, T value)	Deprecated. Set an option for this channel.
boolean	AssembledChannel.supportsOption(Option<?> option)
boolean	AssembledMessageChannel.supportsOption(Option<?> option)
boolean	AssembledStreamChannel.supportsOption(Option<?> option)
boolean	Configurable.supportsOption(Option<?> option)	Determine whether an option is supported on this channel.
boolean	EmptyStreamSourceChannel.supportsOption(Option<?> option)
boolean	FixedLengthStreamSinkChannel.supportsOption(Option<?> option)
boolean	FixedLengthStreamSourceChannel.supportsOption(Option<?> option)
boolean	NullStreamSinkChannel.supportsOption(Option<?> option)
boolean	PushBackStreamChannel.supportsOption(Option<?> option)
boolean	SplitStreamSinkChannel.supportsOption(Option<?> option)
boolean	SplitStreamSourceChannel.supportsOption(Option<?> option)
boolean	TranslatingSuspendableChannel.supportsOption(Option<?> option)	Deprecated. Determine whether an option is supported on this channel.

Uses of Option in org.xnio.conduits

Methods in org.xnio.conduits with parameters of type Option

Modifier and Type	Method	Description
<T> T	ConduitReadableMessageChannel.getOption(Option<T> option)
<T> T	ConduitStreamSinkChannel.getOption(Option<T> option)
<T> T	ConduitStreamSourceChannel.getOption(Option<T> option)
<T> T	ConduitWritableMessageChannel.getOption(Option<T> option)
<T> T	ConduitReadableMessageChannel.setOption(Option<T> option, T value)
<T> T	ConduitStreamSinkChannel.setOption(Option<T> option, T value)
<T> T	ConduitStreamSourceChannel.setOption(Option<T> option, T value)
<T> T	ConduitWritableMessageChannel.setOption(Option<T> option, T value)
boolean	ConduitReadableMessageChannel.supportsOption(Option<?> option)
boolean	ConduitStreamSinkChannel.supportsOption(Option<?> option)
boolean	ConduitStreamSourceChannel.supportsOption(Option<?> option)
boolean	ConduitWritableMessageChannel.supportsOption(Option<?> option)

Uses of Option in org.xnio.ssl

Methods in org.xnio.ssl with parameters of type Option

Modifier and Type	Method	Description
<T> T	JsseSslConnection.getOption(Option<T> option)	Get the value of a channel option.
<T> T	JsseSslStreamConnection.getOption(Option<T> option)	Get the value of a channel option.
<T> T	JsseSslConnection.setOption(Option<T> option, T value)	Set an option for this channel.
<T> T	JsseSslStreamConnection.setOption(Option<T> option, T value)	Set an option for this channel.
boolean	JsseSslConnection.supportsOption(Option<?> option)	Determine whether an option is supported on this channel.
boolean	JsseSslStreamConnection.supportsOption(Option<?> option)	Determine whether an option is supported on this channel.