public final Class Options

Enable or disable blocking I/O for a newly created channel thread.

Configure a server with the specified backlog. The value type for this option is int.

The number of connections to create per connection-balancing token, if connection-balancing is enabled.

The number of balancing tokens, if connection-balancing is enabled. Must be less than the number of I/O threads, or 0 to disable balancing and just accept opportunistically.

Enable broadcast support for IP datagram sockets. The value type for this option is boolean. If you intend to send datagrams to a broadcast address, this option must be enabled.

Configure a TCP socket to send an RST packet on close. The value type for this option is boolean.

The compression level to apply for compressing streams and channels.

The compression type to apply for compressing streams and channels.

The high water mark for a server's connections. Once this number of connections have been accepted, accepts will be suspended for that server.

The low water mark for a server's connections. Once the number of active connections have dropped below this number, accepts can be resumed for that server.

Specify that output should be buffered. The exact behavior of the buffering is not specified; it may flush based on buffered size or time. An explicit SuspendableWriteChannel#flush() will still cause the channel to flush its contents immediately.

The file access mode to use when opening a file.

A flag which indicates that opened files should be appended to. Some platforms do not support both append and FileAccess#READ_WRITE at the same time.

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).

Set the IP traffic class/type-of-service for the channel. The value type for this option is int.

Configure a channel to send TCP keep-alive messages in an implementation-dependent manner. The value type for this option is boolean.

The maximum inbound message size.

Since

2.0

The maximum outbound message size.

Since

2.0

Enable multicast support for a socket. The value type for this option is boolean. Note that some implementations may add overhead when multicast sockets are in use.

Set the multicast time-to-live field for datagram sockets. The value type for this option is int.

Configure a read timeout for a socket, in milliseconds. If the given amount of time elapses without a successful read taking place, the socket's next read will throw a ReadTimeoutException.

The receive buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type. Buffer sizes must always be greater than 0. Note that this value is just a hint; if the application needs to know what value was actually stored for this option, it must call getOption(Options.RECEIVE_BUFFER) on the channel to verify. On most operating systems, the receive buffer size may not be changed on a socket after it is connected; in these cases, calling setOption(Options.RECEIVE_BUFFER, val) will return null.

Configure an IP socket to reuse addresses. The value type for this option is boolean.

A list of disallowed SASL mechanisms.

A list of SASL mechanisms, in decreasing order of preference.

Specify whether SASL mechanisms which implement forward secrecy between sessions are required.

See Also

Sasl#POLICY_FORWARD_SECRECY

Specify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.

See Also

Sasl#POLICY_NOACTIVE

Specify whether SASL mechanisms which accept anonymous logins are permitted.

See Also

Sasl#POLICY_NOANONYMOUS

Specify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.

See Also

Sasl#POLICY_NODICTIONARY

Specify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.

See Also

Sasl#POLICY_NOPLAINTEXT

Specify whether SASL mechanisms which pass client credentials are required.

See Also

Sasl#POLICY_PASS_CREDENTIALS

A list of provider specific SASL properties.

Specify the SASL quality-of-protection to use.

See Also

Sasl#QOP

Specify whether SASL mechanisms should attempt to reuse authenticated session information.

See Also

Sasl#REUSE

Specify whether the SASL server must authenticate to the client.

See Also

Sasl#SERVER_AUTH

Specify the SASL cipher strength to use.

See Also

Sasl#STRENGTH

Determine whether the channel is encrypted, or employs some other level of security. The interpretation of this flag is specific to the channel in question; however, whatever the channel type, this flag is generally read-only.

The send buffer size. The value type for this option is int. This may be used by an XNIO provider directly, or it may be passed to the underlying operating system, depending on the channel type. Buffer sizes must always be greater than 0. Note that this value is just a hint; if the application needs to know what value was actually stored for this option, it must call getOption(Options.SEND_BUFFER) on the channel to verify.

Specify whether read and write operations should be split among separate threads. If true, then each directional channel may be accessed concurrently with respect to one another, and will have different worker threads assigned; otherwise, both directions will share a worker thread and must not be accessed independently.

The size of the allocation region to use for SSL application buffers.

Since

3.0

The application buffer size for SSL.

Since

3.0

Specify the SSL client authentication mode.

Since

2.0

The size of the SSL client session cache.

Since

3.0

The SSL client session timeout (in seconds).

Since

3.0

Enable or disable session creation for an SSL connection. Defaults to true to enable session creation.

Since

2.0

Specify whether SSL should be enabled. If specified in conjunction with SSL_STARTTLS then SSL will not be negotiated until org.xnio.channels.SslChannel#startHandshake() or SslConnection#startHandshake() is called.

Since

3.0

Specify the cipher suites for an SSL/TLS session. If a listed cipher suites is not supported, it is ignored; however, if you specify a list of cipher suites, none of which are supported, an exception will be thrown.

Since

2.0

Specify the enabled protocols for an SSL/TLS session. If a listed protocol is not supported, it is ignored; however, if you specify a list of protocols, none of which are supported, an exception will be thrown.

Since

2.0

The possible key manager classes to use for a JSSE SSL context.

Since

3.0

The possible trust store classes to use for a JSSE SSL context.

Since

3.0

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.

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.

The size of the allocation region to use for SSL packet buffers.

Since

3.0

The packet buffer size for SSL.

Since

3.0

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). If not given, defaults to the host name of the socket address of the peer.

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. If not given, defaults to the port number of the socket address of the peer.

Specify the protocol name for an SSL context.

Since

2.1

Specify the requested provider for an SSL/TLS session.

Since

2.0

The configuration of a secure RNG for SSL usage.

Since

3.0

The size of the SSL server session cache.

Since

3.0

The SSL server session timeout (in seconds).

Since

3.0

Specify whether to use STARTTLS mode (in which a connection starts clear and switches to TLS on demand).

Since

3.0

Get the supported cipher suites for an SSL/TLS session. This option is generally read-only.

Since

2.0

Get the supported protocols for an SSL/TLS session. This option is generally read-only.

Since

2.0

Specify whether SSL conversations should be in client or server mode. Defaults to false (use server mode). If set to true, the client and server side swap negotiation roles.

Since

2.0

The stack size (in bytes) to attempt to use for worker threads.

Configure a TCP socket to disable Nagle's algorithm. The value type for this option is boolean.

Configure a TCP socket to receive out-of-band data alongside regular data. The value type for this option is boolean.

Specify whether worker threads should be daemon threads. Defaults to false.

The thread priority for newly created worker threads. If not specified, the platform default value will be used.

Specify whether direct buffers should be used for socket communications.

Since

3.0

The poll interval for poll based file system watchers. Defaults to 5000ms. Ignored on Java 7 and later.

Specify the number of accept threads a single socket server should have. Specifying more than one can result in spurious wakeups for a socket server under low connection volume, but higher throughput at high connection volume. The minimum value is 1, and the maximum value is equal to the number of available worker threads.

Specify whether a server, acceptor, or connector should be attached to write threads. By default, the establishing phase of connections are attached to read threads. Use this option if the client or server writes a message directly upon connect and a split threads configuration is used.

Specify the number of I/O threads to create for the worker. If not specified, a default will be chosen.

The name to use for a newly created worker. If not specified, the string "XNIO" will be used. The worker name is used as a part of the thread name for created threads, and for any management constructs.

Specify the number of I/O threads to devote to reading for split thread channels. If not specified, a default will be chosen to be roughly half of the worker I/O threads, or the number of threads not specified for writing.

Specify the number of "core" threads for the worker task thread pool.

Specify the number of milliseconds to keep non-core task threads alive.

Specify the maximum number of worker tasks to allow before rejecting.

Specify the maximum number of threads for the worker task thread pool.

Specify the number of I/O threads to devote to writing for split thread channels. If not specified, a default will be chosen to be roughly half of the worker I/O threads, or the number of threads not specified for reading.

Configure a write timeout for a socket, in milliseconds. If the given amount of time elapses without a successful write taking place, the socket's next write will throw a WriteTimeoutException.