Uses of Class org.xnio.Option (XNIO API 3.0.7.GA API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

XNIO API 3.0.7.GA

PREV NEXT

FRAMES NO FRAMES

Uses of Class
org.xnio.Option

Packages that use Option
org.xnio	The main API package for XNIO.
org.xnio.channels

Uses of Option in org.xnio

Fields in org.xnio declared as Option
`static Option<Boolean>`	`Options.ALLOW_BLOCKING` Enable or disable blocking I/O for a newly created channel thread.
`static Option<Integer>`	`Options.BACKLOG` Configure a server with the specified backlog.
`static Option<Boolean>`	`Options.BROADCAST` Enable broadcast support for IP datagram sockets.
`static Option<Boolean>`	`Options.CLOSE_ABORT` Configure a TCP socket to send an `RST` packet on close.
`static Option<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<Integer>`	`Options.IP_TRAFFIC_CLASS` Set the IP traffic class/type-of-service for the channel.
`static Option<Boolean>`	`Options.KEEP_ALIVE` Configure a channel to send a periodic heartbeat of some sort.
`static Option<Integer>`	`Options.MAX_INBOUND_MESSAGE_SIZE` The maximum inbound message size.
`static Option<Integer>`	`Options.MAX_OUTBOUND_MESSAGE_SIZE` The maximum outbound message size.
`static Option<Boolean>`	`Options.MULTICAST` Enable multicast support for a socket.
`static Option<Integer>`	`Options.MULTICAST_TTL` Set the multicast time-to-live field for datagram sockets.
`static Option<Integer>`	`Options.READ_TIMEOUT` Configure a read timeout for a socket, in milliseconds.
`static Option<Integer>`	`Options.RECEIVE_BUFFER` The receive buffer size.
`static Option<Boolean>`	`Options.REUSE_ADDRESSES` Configure an IP socket to reuse addresses.
`static Option<Sequence<String>>`	`Options.SASL_DISALLOWED_MECHANISMS` A list of disallowed SASL mechanisms.
`static Option<Sequence<String>>`	`Options.SASL_MECHANISMS` A list of SASL mechanisms, in decreasing order of preference.
`static Option<Boolean>`	`Options.SASL_POLICY_FORWARD_SECRECY` Specify whether SASL mechanisms which implement forward secrecy between sessions are required.
`static Option<Boolean>`	`Options.SASL_POLICY_NOACTIVE` Specify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.
`static Option<Boolean>`	`Options.SASL_POLICY_NOANONYMOUS` Specify whether SASL mechanisms which accept anonymous logins are permitted.
`static Option<Boolean>`	`Options.SASL_POLICY_NODICTIONARY` Specify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.
`static Option<Boolean>`	`Options.SASL_POLICY_NOPLAINTEXT` Specify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.
`static Option<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<Boolean>`	`Options.SASL_REUSE` Specify whether SASL mechanisms should attempt to reuse authenticated session information.
`static Option<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<Boolean>`	`Options.SECURE` Determine whether the channel is encrypted, or employs some other level of security.
`static Option<Integer>`	`Options.SEND_BUFFER` The send buffer size.
`static Option<Integer>`	`Options.SSL_APPLICATION_BUFFER_REGION_SIZE` The size of the allocation region to use for SSL application buffers.
`static Option<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<Integer>`	`Options.SSL_CLIENT_SESSION_CACHE_SIZE` The size of the SSL client session cache.
`static Option<Integer>`	`Options.SSL_CLIENT_SESSION_TIMEOUT` The SSL client session timeout (in seconds).
`static Option<Boolean>`	`Options.SSL_ENABLE_SESSION_CREATION` Enable or disable session creation for an SSL connection.
`static Option<Boolean>`	`Options.SSL_ENABLED` Specify whether SSL should be enabled.
`static Option<Sequence<String>>`	`Options.SSL_ENABLED_CIPHER_SUITES` Specify the cipher suites for an SSL/TLS session.
`static Option<Sequence<String>>`	`Options.SSL_ENABLED_PROTOCOLS` Specify the enabled protocols for an SSL/TLS session.
`static Option<Sequence<Class<? extends KeyManager>>>`	`Options.SSL_JSSE_KEY_MANAGER_CLASSES` The possible key manager classes to use for a JSSE SSL context.
`static Option<Sequence<Class<? extends TrustManager>>>`	`Options.SSL_JSSE_TRUST_MANAGER_CLASSES` The possible trust store classes to use for a JSSE SSL context.
`static Option<Integer>`	`Options.SSL_PACKET_BUFFER_REGION_SIZE` The size of the allocation region to use for SSL packet buffers.
`static Option<Integer>`	`Options.SSL_PACKET_BUFFER_SIZE` The packet buffer size for SSL.
`static Option<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<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<String>`	`Options.SSL_PROTOCOL` Specify the protocol name for an SSL context.
`static Option<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<Integer>`	`Options.SSL_SERVER_SESSION_CACHE_SIZE` The size of the SSL server session cache.
`static Option<Integer>`	`Options.SSL_SERVER_SESSION_TIMEOUT` The SSL server session timeout (in seconds).
`static Option<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<String>>`	`Options.SSL_SUPPORTED_CIPHER_SUITES` Get the supported cipher suites for an SSL/TLS session.
`static Option<Sequence<String>>`	`Options.SSL_SUPPORTED_PROTOCOLS` Get the supported protocols for an SSL/TLS session.
`static Option<Boolean>`	`Options.SSL_USE_CLIENT_MODE` Specify whether SSL conversations should be in client or server mode.
`static Option<Long>`	`Options.STACK_SIZE` The stack size (in bytes) to attempt to use for worker threads.
`static Option<Boolean>`	`Options.TCP_NODELAY` Configure a TCP socket to disable Nagle's algorithm.
`static Option<Boolean>`	`Options.TCP_OOB_INLINE` Configure a TCP socket to receive out-of-band data alongside regular data.
`static Option<Boolean>`	`Options.THREAD_DAEMON` Specify whether worker threads should be daemon threads.
`static Option<Integer>`	`Options.THREAD_PRIORITY` The thread priority for newly created worker threads.
`static Option<Boolean>`	`Options.USE_DIRECT_BUFFERS` Specify whether direct buffers should be used for socket communications.
`static Option<Integer>`	`Options.WORKER_ACCEPT_THREADS` Specify the number of accept threads a single socket server should have.
`static Option<Boolean>`	`Options.WORKER_ESTABLISH_WRITING` Specify whether a server, acceptor, or connector should be attached to write threads.
`static Option<String>`	`Options.WORKER_NAME` The name to use for a newly created worker.
`static Option<Integer>`	`Options.WORKER_READ_THREADS` Specify the number of read threads to create for the worker.
`static Option<Integer>`	`Options.WORKER_TASK_CORE_THREADS` Specify the number of "core" threads for the worker task thread pool.
`static Option<Integer>`	`Options.WORKER_TASK_KEEPALIVE` Specify the number of milliseconds to keep non-core task threads alive.
`static Option<Integer>`	`Options.WORKER_TASK_LIMIT` Specify the maximum number of worker tasks to allow before rejecting.
`static Option<Integer>`	`Options.WORKER_TASK_MAX_THREADS` Specify the maximum number of threads for the worker task thread pool.
`static Option<Integer>`	`Options.WORKER_WRITE_THREADS` Specify the number of write threads to create for the worker.
`static Option<Integer>`	`Options.WRITE_TIMEOUT` Configure a write timeout for a socket, in milliseconds.

Methods in org.xnio that return Option

static Option<?> Option.fromString(String name, ClassLoader classLoader)
Get an option from a string name, using the given classloader.

static



<T> Option<Sequence<T>>

Option.sequence(Class<?> declClass,
         String name,
         Class<T> elementType)

Create an option with a sequence type.

static



<T> Option<T>

Option.simple(Class<?> declClass,
       String name,
       Class<T> type)

Create an option with a simple type.

static



<T> Option<Class<? extends T>>

Option.type(Class<?> declClass,
     String name,
     Class<T> declType)

Create an option with a class type.

static



<T> Option<Sequence<Class<? extends T>>>

Option.typeSequence(Class<?> declClass,
             String name,
             Class<T> elementDeclType)

Create an option with a sequence-of-types type.

Methods in org.xnio that return types with arguments of type Option
`Set<Option<?>>`	`Option.SetBuilder.create()` Create the immutable option set instance.
`Iterator<Option<?>>`	`OptionMap.iterator()` Iterate over the options in this map.

Methods in org.xnio with parameters of type Option

Option.SetBuilder Option.SetBuilder.add(Option<?> option)
Add an option 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.

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

XnioWorker.getOption(Option<T> option)





<T> OptionMap.Builder

OptionMap.Builder.parse(Option<T> key,
      String stringValue)

Set a key-value pair, parsing the value from the given string.





<T> OptionMap.Builder

OptionMap.Builder.parse(Option<T> key,
      String stringValue,
      ClassLoader classLoader)

Set a key-value pair, parsing the value from the given string.

OptionMap.Builder OptionMap.Builder.set(Option<Boolean> key, boolean value)
Set a boolean value for a Boolean key.

OptionMap.Builder OptionMap.Builder.set(Option<Integer> key, int value)
Set an int value for an Integer key.

OptionMap.Builder OptionMap.Builder.set(Option<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

XnioWorker.setOption(Option<T> option,
          T value)

OptionMap.Builder OptionMap.Builder.setSequence(Option<Sequence<Boolean>> key, boolean... values)
Set boolean values for an Boolean sequence key.

OptionMap.Builder OptionMap.Builder.setSequence(Option<Sequence<Integer>> key, int... values)
Set int values for an Integer sequence key.

OptionMap.Builder OptionMap.Builder.setSequence(Option<Sequence<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 XnioWorker.supportsOption(Option<?> option)

Method parameters in org.xnio with type arguments of type Option
`Option.SetBuilder`	`Option.SetBuilder.addAll(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

static boolean Channels.getOption(Configurable configurable, Option<Boolean> option, boolean defaultValue)
Get an option value from a configurable target.

static int Channels.getOption(Configurable configurable, Option<Integer> option, int defaultValue)
Get an option value from a configurable target.

static long Channels.getOption(Configurable configurable, Option<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

TranslatingSuspendableChannel.getOption(Option<T> option)
Get the value of a channel option.





<T> T

Configurable.getOption(Option<T> option)
Get the value of a channel option.





<T> T

TranslatingSuspendableChannel.setOption(Option<T> option,
          T value)

Set an option for this channel.





<T> T

Configurable.setOption(Option<T> option,
          T value)