Uses of Class
org.xnio.Option
Packages that use Option
Package
Description
The main API package for XNIO.
The core XNIO channel API.
The XNIO conduit SPI.
Utility classes for using and implementing SSL within XNIO providers.
-
Uses of Option in org.xnio
Modifier and TypeFieldDescriptionOptions.ALLOW_BLOCKINGEnable or disable blocking I/O for a newly created channel thread.Options.BACKLOGConfigure a server with the specified backlog.Options.BALANCING_CONNECTIONSThe number of connections to create per connection-balancing token, if connection-balancing is enabled.Options.BALANCING_TOKENSThe number of balancing tokens, if connection-balancing is enabled.Options.BROADCASTEnable broadcast support for IP datagram sockets.Options.CLOSE_ABORTConfigure a TCP socket to send anRSTpacket on close.Options.COMPRESSION_LEVELThe compression level to apply for compressing streams and channels.static final Option<CompressionType>Options.COMPRESSION_TYPEThe compression type to apply for compressing streams and channels.Options.CONNECTION_HIGH_WATERThe high water mark for a server's connections.Options.CONNECTION_LOW_WATERThe low water mark for a server's connections.Options.CORKSpecify that output should be buffered.static final Option<FileAccess>Options.FILE_ACCESSThe file access mode to use when opening a file.Options.FILE_APPENDA flag which indicates that opened files should be appended to.Options.FILE_CREATEA flag which indicates that a file should be created if it does not exist (trueby default for writing files,falseby default for reading files).Options.IP_TRAFFIC_CLASSSet the IP traffic class/type-of-service for the channel.Options.KEEP_ALIVEConfigure a channel to send TCP keep-alive messages in an implementation-dependent manner.Options.MAX_INBOUND_MESSAGE_SIZEThe maximum inbound message size.Options.MAX_OUTBOUND_MESSAGE_SIZEThe maximum outbound message size.Options.MULTICASTEnable multicast support for a socket.Options.MULTICAST_TTLSet the multicast time-to-live field for datagram sockets.Options.READ_TIMEOUTConfigure a read timeout for a socket, in milliseconds.Options.RECEIVE_BUFFERThe receive buffer size.Options.REUSE_ADDRESSESConfigure an IP socket to reuse addresses.Options.SASL_DISALLOWED_MECHANISMSA list of disallowed SASL mechanisms.Options.SASL_MECHANISMSA list of SASL mechanisms, in decreasing order of preference.Options.SASL_POLICY_FORWARD_SECRECYSpecify whether SASL mechanisms which implement forward secrecy between sessions are required.Options.SASL_POLICY_NOACTIVESpecify whether SASL mechanisms which are susceptible to active (non-dictionary) attacks are permitted.Options.SASL_POLICY_NOANONYMOUSSpecify whether SASL mechanisms which accept anonymous logins are permitted.Options.SASL_POLICY_NODICTIONARYSpecify whether SASL mechanisms which are susceptible to passive dictionary attacks are permitted.Options.SASL_POLICY_NOPLAINTEXTSpecify whether SASL mechanisms which are susceptible to simple plain passive attacks are permitted.Options.SASL_POLICY_PASS_CREDENTIALSSpecify whether SASL mechanisms which pass client credentials are required.Options.SASL_PROPERTIESA list of provider specific SASL properties.Options.SASL_QOPSpecify the SASL quality-of-protection to use.Options.SASL_REUSESpecify whether SASL mechanisms should attempt to reuse authenticated session information.Options.SASL_SERVER_AUTHSpecify whether the SASL server must authenticate to the client.static final Option<SaslStrength>Options.SASL_STRENGTHSpecify the SASL cipher strength to use.Options.SECUREDetermine whether the channel is encrypted, or employs some other level of security.Options.SEND_BUFFERThe send buffer size.Options.SPLIT_READ_WRITE_THREADSSpecify whether read and write operations should be split among separate threads.The size of the allocation region to use for SSL application buffers.Options.SSL_APPLICATION_BUFFER_SIZEThe application buffer size for SSL.static final Option<SslClientAuthMode>Options.SSL_CLIENT_AUTH_MODESpecify the SSL client authentication mode.Options.SSL_CLIENT_SESSION_CACHE_SIZEThe size of the SSL client session cache.Options.SSL_CLIENT_SESSION_TIMEOUTThe SSL client session timeout (in seconds).Options.SSL_ENABLE_SESSION_CREATIONEnable or disable session creation for an SSL connection.Options.SSL_ENABLEDSpecify whether SSL should be enabled.Options.SSL_ENABLED_CIPHER_SUITESSpecify the cipher suites for an SSL/TLS session.Options.SSL_ENABLED_PROTOCOLSSpecify the enabled protocols for an SSL/TLS session.static final Option<Sequence<Class<? extends KeyManager>>>Options.SSL_JSSE_KEY_MANAGER_CLASSESThe possible key manager classes to use for a JSSE SSL context.static final Option<Sequence<Class<? extends TrustManager>>>Options.SSL_JSSE_TRUST_MANAGER_CLASSESThe possible trust store classes to use for a JSSE SSL context.Options.SSL_NON_BLOCKING_KEY_MANAGERHint 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.Options.SSL_NON_BLOCKING_TRUST_MANAGERHint 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.Options.SSL_PACKET_BUFFER_REGION_SIZEThe size of the allocation region to use for SSL packet buffers.Options.SSL_PACKET_BUFFER_SIZEThe packet buffer size for SSL.Options.SSL_PEER_HOST_NAMESpecify 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).Options.SSL_PEER_PORTSpecify 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.Options.SSL_PROTOCOLSpecify the protocol name for an SSL context.Options.SSL_PROVIDERSpecify the requested provider for an SSL/TLS session.Options.SSL_RNG_OPTIONSThe configuration of a secure RNG for SSL usage.Options.SSL_SERVER_SESSION_CACHE_SIZEThe size of the SSL server session cache.Options.SSL_SERVER_SESSION_TIMEOUTThe SSL server session timeout (in seconds).Options.SSL_STARTTLSSpecify whether to use STARTTLS mode (in which a connection starts clear and switches to TLS on demand).Options.SSL_SUPPORTED_CIPHER_SUITESGet the supported cipher suites for an SSL/TLS session.Options.SSL_SUPPORTED_PROTOCOLSGet the supported protocols for an SSL/TLS session.Options.SSL_USE_CLIENT_MODESpecify whether SSL conversations should be in client or server mode.Options.STACK_SIZEThe stack size (in bytes) to attempt to use for worker threads.Options.TCP_NODELAYConfigure a TCP socket to disable Nagle's algorithm.Options.TCP_OOB_INLINEConfigure a TCP socket to receive out-of-band data alongside regular data.Options.THREAD_DAEMONSpecify whether worker threads should be daemon threads.Options.THREAD_PRIORITYThe thread priority for newly created worker threads.Options.USE_DIRECT_BUFFERSSpecify whether direct buffers should be used for socket communications.Options.WATCHER_POLL_INTERVALThe poll interval for poll based file system watchers.Options.WORKER_ACCEPT_THREADSDeprecated.This option is now ignored.Options.WORKER_ESTABLISH_WRITINGSpecify whether a server, acceptor, or connector should be attached to write threads.Options.WORKER_IO_THREADSSpecify the number of I/O threads to create for the worker.Options.WORKER_NAMEThe name to use for a newly created worker.Options.WORKER_READ_THREADSSpecify the number of I/O threads to devote to reading for split thread channels.Options.WORKER_TASK_CORE_THREADSSpecify the number of "core" threads for the worker task thread pool.Options.WORKER_TASK_KEEPALIVESpecify the number of milliseconds to keep non-core task threads alive.Options.WORKER_TASK_LIMITSpecify the maximum number of worker tasks to allow before rejecting.Options.WORKER_TASK_MAX_THREADSSpecify the maximum number of threads for the worker task thread pool.Options.WORKER_WRITE_THREADSSpecify the number of I/O threads to devote to writing for split thread channels.Options.WRITE_TIMEOUTConfigure a write timeout for a socket, in milliseconds.Modifier and TypeMethodDescriptionstatic Option<?>Option.fromString(String name, ClassLoader classLoader) Get an option from a string name, using the given classloader.Create an option with a sequence type.static <T> Option<T>Create an option with a simple type.Create an option with a class type.Option.typeSequence(Class<?> declClass, String name, Class<T> elementDeclType) Create an option with a sequence-of-types type.Modifier and TypeMethodDescriptionOption.SetBuilder.create()Create the immutable option set instance.OptionMap.iterator()Iterate over the options in this map.Modifier and TypeMethodDescriptionAdd an option to this set.Add options to this set.Add options to this set.Add options to this set.booleanDetermine whether this option map contains the given option.static <T> OptionMapCreate a single-valued option map.static <T1,T2> OptionMap Create a two-valued option map.booleanGet a boolean value from this option map, with a specified default if the value is missing.intGet a int value from this option map, with a specified default if the value is missing.longGet a long value from this option map, with a specified default if the value is missing.<T> TGet the value of an option from this option map.<T> TGet the value of an option from this option map, with a specified default if the value is missing.<T> T<T> TSet a key-value pair, parsing the value from the given string.OptionMap.Builder.parse(Option<T> key, String stringValue, ClassLoader classLoader) Set a key-value pair, parsing the value from the given string.Set a boolean value for a Boolean key.Set an int value for an Integer key.Set a long value for a Long key.Set a key-value pair.<T> T<T> TOptionMap.Builder.setSequence(Option<Sequence<Boolean>> key, boolean... values) Set boolean values for an Boolean sequence key.OptionMap.Builder.setSequence(Option<Sequence<Integer>> key, int... values) Set int values for an Integer sequence key.OptionMap.Builder.setSequence(Option<Sequence<Long>> key, long... values) Set long values for a Long sequence key.OptionMap.Builder.setSequence(Option<Sequence<T>> key, T... values) Set a key-value pair, where the value is a sequence type.booleanConnection.supportsOption(Option<?> option) booleanXnioWorker.supportsOption(Option<?> option) Modifier and TypeMethodDescriptionOption.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 OptionModifier and TypeMethodDescription<T> T<T> T<T> Tstatic booleanChannels.getOption(Configurable configurable, Option<Boolean> option, boolean defaultValue) Get an option value from a configurable target.static intChannels.getOption(Configurable configurable, Option<Integer> option, int defaultValue) Get an option value from a configurable target.static longChannels.getOption(Configurable configurable, Option<Long> option, long defaultValue) Get an option value from a configurable target.static <T> TChannels.getOption(Configurable configurable, Option<T> option, T defaultValue) Get an option value from a configurable target.<T> TGet the value of a channel option.<T> T<T> T<T> T<T> T<T> T<T> T<T> T<T> TDeprecated.Get the value of a channel option.<T> T<T> T<T> T<T> TSet an option for this channel.<T> T<T> T<T> T<T> T<T> T<T> T<T> T<T> TDeprecated.Set an option for this channel.booleanAssembledChannel.supportsOption(Option<?> option) booleanAssembledMessageChannel.supportsOption(Option<?> option) booleanAssembledStreamChannel.supportsOption(Option<?> option) booleanConfigurable.supportsOption(Option<?> option) Determine whether an option is supported on this channel.booleanEmptyStreamSourceChannel.supportsOption(Option<?> option) booleanFixedLengthStreamSinkChannel.supportsOption(Option<?> option) booleanFixedLengthStreamSourceChannel.supportsOption(Option<?> option) booleanNullStreamSinkChannel.supportsOption(Option<?> option) booleanPushBackStreamChannel.supportsOption(Option<?> option) booleanSplitStreamSinkChannel.supportsOption(Option<?> option) booleanSplitStreamSourceChannel.supportsOption(Option<?> option) booleanTranslatingSuspendableChannel.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 OptionModifier and TypeMethodDescription<T> T<T> T<T> T<T> T<T> T<T> T<T> T<T> TbooleanConduitReadableMessageChannel.supportsOption(Option<?> option) booleanConduitStreamSinkChannel.supportsOption(Option<?> option) booleanConduitStreamSourceChannel.supportsOption(Option<?> option) booleanConduitWritableMessageChannel.supportsOption(Option<?> option) -
Uses of Option in org.xnio.ssl
Methods in org.xnio.ssl with parameters of type OptionModifier and TypeMethodDescription<T> TGet the value of a channel option.<T> TGet the value of a channel option.<T> TSet an option for this channel.<T> TSet an option for this channel.booleanJsseSslConnection.supportsOption(Option<?> option) Determine whether an option is supported on this channel.booleanJsseSslStreamConnection.supportsOption(Option<?> option) Determine whether an option is supported on this channel.