NIOTransportBuilder (grizzly-framework 3.0.0 API)

java.lang.Object
- org.glassfish.grizzly.NIOTransportBuilder<T>

Direct Known Subclasses:

TCPNIOTransportBuilder, UDPNIOTransportBuilder
```
public abstract class NIOTransportBuilder<T extends NIOTransportBuilder>
extends Object
```
This builder is responsible for creating NIOTransport implementations as well as providing basic configuration for IOStrategies and thread pools.

Since:

2.0

See Also:

NIOTransport, IOStrategy, ThreadPoolConfig

Field Summary

Fields
Modifier and Type	Field and Description
`protected AttributeBuilder`	`attributeBuilder`
`protected int`	`clientSocketSoTimeout`
`protected int`	`connectionTimeout`
`protected IOStrategy`	`ioStrategy`
`protected ThreadPoolConfig`	`kernelConfig`
`protected int`	`maxPendingBytesPerConnection`
`protected MemoryManager`	`memoryManager`
`protected String`	`name`
`protected NIOChannelDistributor`	`nioChannelDistributor`
`protected boolean`	`optimizedForMultiplexing`
`protected Processor`	`processor`
`protected ProcessorSelector`	`processorSelector`
`protected int`	`readBufferSize`
`protected long`	`readTimeout`
`protected boolean`	`reuseAddress`
`protected SelectionKeyHandler`	`selectionKeyHandler`
`protected SelectorHandler`	`selectorHandler`
`protected SelectorProvider`	`selectorProvider`
`protected int`	`selectorRunnerCount`
`protected Class<? extends NIOTransport>`	`transportClass`
`protected ThreadPoolConfig`	`workerConfig`
`protected int`	`writeBufferSize`
`protected long`	`writeTimeout`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`NIOTransportBuilder(Class<? extends NIOTransport> transportClass)` Constructs a new `NIOTransport` using the given `transportClass` and `IOStrategy`.

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`NIOTransport`	`build()`
`protected abstract NIOTransport`	`create(String name)`
`AttributeBuilder`	`getAttributeBuilder()`
`int`	`getClientSocketSoTimeout()`
`int`	`getConnectionTimeout()`
`IOStrategy`	`getIOStrategy()`
`int`	`getMaxAsyncWriteQueueSizeInBytes()` Max asynchronous write queue size in bytes
`MemoryManager`	`getMemoryManager()`
`String`	`getName()`
`NIOChannelDistributor`	`getNIOChannelDistributor()`
`Processor`	`getProcessor()`
`ProcessorSelector`	`getProcessorSelector()`
`int`	`getReadBufferSize()`
`long`	`getReadTimeout(TimeUnit timeUnit)`
`SelectionKeyHandler`	`getSelectionKeyHandler()`
`SelectorHandler`	`getSelectorHandler()`
`SelectorProvider`	`getSelectorProvider()`
`int`	`getSelectorRunnersCount()`
`ThreadPoolConfig`	`getSelectorThreadPoolConfig()`
`protected abstract T`	`getThis()`
`ThreadPoolConfig`	`getWorkerThreadPoolConfig()`
`int`	`getWriteBufferSize()`
`long`	`getWriteTimeout(TimeUnit timeUnit)`
`boolean`	`isOptimizedForMultiplexing()`
`boolean`	`isReuseAddress()` Whether address may be reused for multiple sockets
`T`	`setAttributeBuilder(AttributeBuilder attributeBuilder)` Set the `AttributeBuilder` to be used by the created `NIOTransport`.
`T`	`setClientSocketSoTimeout(int clientSocketSoTimeout)` Sets the timeout on socket blocking operations for the client
`T`	`setConnectionTimeout(int connectionTimeout)`
`T`	`setIOStrategy(IOStrategy ioStrategy)` Changes the `IOStrategy` that will be used.
`T`	`setMaxAsyncWriteQueueSizeInBytes(int maxAsyncWriteQueueSizeInBytes)`
`T`	`setMemoryManager(MemoryManager memoryManager)` Set the `MemoryManager` to be used by the created `NIOTransport`.
`T`	`setName(String name)`
`T`	`setNIOChannelDistributor(NIOChannelDistributor nioChannelDistributor)` Set the `NIOChannelDistributor` to be used by the created `NIOTransport`.
`T`	`setOptimizedForMultiplexing(boolean optimizedForMultiplexing)`
`T`	`setProcessor(Processor processor)`
`T`	`setProcessorSelector(ProcessorSelector processorSelector)`
`T`	`setReadBufferSize(int readBufferSize)`
`T`	`setReadTimeout(long timeout, TimeUnit timeUnit)` Sets the value of the blocking read timeout
`T`	`setReuseAddress(boolean reuseAddress)` Sets whether address may be reused for multiple sockets
`T`	`setSelectionKeyHandler(SelectionKeyHandler selectionKeyHandler)` Set the `SelectionKeyHandler` to be used by the created `NIOTransport`.
`T`	`setSelectorHandler(SelectorHandler selectorHandler)` Set the `SelectorHandler` to be used by the created `NIOTransport`.
`T`	`setSelectorProvider(SelectorProvider selectorProvider)` Set the `SelectorProvider` to be used by the created `NIOTransport`.
`T`	`setSelectorRunnersCount(int selectorRunnersCount)` Sets the number of `Selector`s to be created to serve Transport connections.
`T`	`setSelectorThreadPoolConfig(ThreadPoolConfig kernelConfig)` Sets the `ThreadPoolConfig` that will be used to construct the `ExecutorService` which will run the `NIOTransport`'s `SelectorRunner`s.
`T`	`setWorkerThreadPoolConfig(ThreadPoolConfig workerConfig)` Sets the `ThreadPoolConfig` that will be used to construct the `ExecutorService` for `IOStrategies` that require worker threads
`T`	`setWriteBufferSize(int writeBufferSize)`
`T`	`setWriteTimeout(long timeout, TimeUnit timeUnit)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - transportClass
```
protected final Class<? extends NIOTransport> transportClass
```
  - workerConfig
```
protected ThreadPoolConfig workerConfig
```
  - kernelConfig
```
protected ThreadPoolConfig kernelConfig
```
  - selectorProvider
```
protected SelectorProvider selectorProvider
```
  - selectorHandler
```
protected SelectorHandler selectorHandler
```
  - selectionKeyHandler
```
protected SelectionKeyHandler selectionKeyHandler
```
  - memoryManager
```
protected MemoryManager memoryManager
```
  - attributeBuilder
```
protected AttributeBuilder attributeBuilder
```
  - ioStrategy
```
protected IOStrategy ioStrategy
```
  - selectorRunnerCount
```
protected int selectorRunnerCount
```
  - nioChannelDistributor
```
protected NIOChannelDistributor nioChannelDistributor
```
  - name
```
protected String name
```
  - processor
```
protected Processor processor
```
  - processorSelector
```
protected ProcessorSelector processorSelector
```
  - readBufferSize
```
protected int readBufferSize
```
  - writeBufferSize
```
protected int writeBufferSize
```
  - clientSocketSoTimeout
```
protected int clientSocketSoTimeout
```
  - connectionTimeout
```
protected int connectionTimeout
```
  - reuseAddress
```
protected boolean reuseAddress
```
  - maxPendingBytesPerConnection
```
protected int maxPendingBytesPerConnection
```
  - optimizedForMultiplexing
```
protected boolean optimizedForMultiplexing
```
  - readTimeout
```
protected long readTimeout
```
  - writeTimeout
```
protected long writeTimeout
```
- Constructor Detail
  - NIOTransportBuilder
```
protected NIOTransportBuilder(Class<? extends NIOTransport> transportClass)
```
    Constructs a new NIOTransport using the given transportClass and IOStrategy.
    
    The builder's worker thread pool configuration will be based on the return value of WorkerThreadPoolConfigProducer.createDefaultWorkerPoolConfig(Transport). If worker thread configuration is non-null, the initial selector thread pool configuration will be cloned from it, otherwise a default configuration will be chosen.
    
    Parameters:
    
    transportClass - the class of the NIOTransport implementation to be used.
- Method Detail
  - getSelectorRunnersCount
```
public int getSelectorRunnersCount()
```
    Returns:
    
    the number of Selectors to be created to serve Transport connections. -1 is the default value, which lets the Transport to pick the value, usually it's equal to the number of CPU cores Runtime.availableProcessors()
  - setSelectorRunnersCount
```
public T setSelectorRunnersCount(int selectorRunnersCount)
```
    Sets the number of Selectors to be created to serve Transport connections. -1 is the default value, which lets the Transport to pick the value, usually it's equal to the number of CPU cores Runtime.availableProcessors().
    
    Parameters:
    
    selectorRunnersCount - number of channels
    
    Returns:
    
    the builder
  - getWorkerThreadPoolConfig
```
public ThreadPoolConfig getWorkerThreadPoolConfig()
```
    Returns:
    
    the ThreadPoolConfig that will be used to construct the ExecutorService for IOStrategies that require worker threads. This method will return null if a ThreadPoolConfig had not been previously set.
  - setWorkerThreadPoolConfig
```
public T setWorkerThreadPoolConfig(ThreadPoolConfig workerConfig)
```
    Sets the ThreadPoolConfig that will be used to construct the ExecutorService for IOStrategies that require worker threads
    
    Parameters:
    
    workerConfig - the config
    
    Returns:
    
    this builder
  - getSelectorThreadPoolConfig
```
public ThreadPoolConfig getSelectorThreadPoolConfig()
```
    Returns:
    
    the ThreadPoolConfig that will be used to construct the ExecutorService which will run the NIOTransport's SelectorRunners.
  - setSelectorThreadPoolConfig
```
public T setSelectorThreadPoolConfig(ThreadPoolConfig kernelConfig)
```
    Sets the ThreadPoolConfig that will be used to construct the ExecutorService which will run the NIOTransport's SelectorRunners.
    
    Parameters:
    
    kernelConfig - the config
    
    Returns:
    
    this builder
  - getIOStrategy
```
public IOStrategy getIOStrategy()
```
    Returns:
    
    the IOStrategy that will be used by the created NIOTransport.
  - setIOStrategy
```
public T setIOStrategy(IOStrategy ioStrategy)
```
    Changes the IOStrategy that will be used. Invoking this method may change the return value of getWorkerThreadPoolConfig()
    
    Parameters:
    
    ioStrategy - the IOStrategy to use.
    
    Returns:
    
    this NIOTransportBuilder
  - getMemoryManager
```
public MemoryManager getMemoryManager()
```
    Returns:
    
    the MemoryManager that will be used by the created NIOTransport. If not explicitly set, then MemoryManager.DEFAULT_MEMORY_MANAGER will be used.
  - setMemoryManager
```
public T setMemoryManager(MemoryManager memoryManager)
```
    Set the MemoryManager to be used by the created NIOTransport.
    
    Parameters:
    
    memoryManager - the MemoryManager.
    
    Returns:
    
    this NIOTransportBuilder
  - getSelectorHandler
```
public SelectorHandler getSelectorHandler()
```
    Returns:
    
    the SelectorHandler that will be used by the created NIOTransport. If not explicitly set, then SelectorHandler.DEFAULT_SELECTOR_HANDLER will be used.
  - setSelectorHandler
```
public T setSelectorHandler(SelectorHandler selectorHandler)
```
    Set the SelectorHandler to be used by the created NIOTransport.
    
    Parameters:
    
    selectorHandler - the SelectorHandler.
    
    Returns:
    
    this NIOTransportBuilder
  - getSelectionKeyHandler
```
public SelectionKeyHandler getSelectionKeyHandler()
```
    Returns:
    
    the SelectionKeyHandler that will be used by the created NIOTransport. If not explicitly set, then SelectionKeyHandler.DEFAULT_SELECTION_KEY_HANDLER will be used.
  - setSelectionKeyHandler
```
public T setSelectionKeyHandler(SelectionKeyHandler selectionKeyHandler)
```
    Set the SelectionKeyHandler to be used by the created NIOTransport.
    
    Parameters:
    
    selectionKeyHandler - the SelectionKeyHandler.
    
    Returns:
    
    this NIOTransportBuilder
  - getAttributeBuilder
```
public AttributeBuilder getAttributeBuilder()
```
    Returns:
    
    the AttributeBuilder that will be used by the created NIOTransport. If not explicitly set, then AttributeBuilder.DEFAULT_ATTRIBUTE_BUILDER will be used.
  - setAttributeBuilder
```
public T setAttributeBuilder(AttributeBuilder attributeBuilder)
```
    Set the AttributeBuilder to be used by the created NIOTransport.
    
    Parameters:
    
    attributeBuilder - the AttributeBuilder.
    
    Returns:
    
    this NIOTransportBuilder
  - getNIOChannelDistributor
```
public NIOChannelDistributor getNIOChannelDistributor()
```
    Returns:
    
    the NIOChannelDistributor that will be used by the created NIOTransport. If not explicitly set, then AttributeBuilder.DEFAULT_ATTRIBUTE_BUILDER will be used.
  - setNIOChannelDistributor
```
public T setNIOChannelDistributor(NIOChannelDistributor nioChannelDistributor)
```
    Set the NIOChannelDistributor to be used by the created NIOTransport.
    
    Parameters:
    
    nioChannelDistributor - the NIOChannelDistributor.
    
    Returns:
    
    this NIOTransportBuilder
  - getSelectorProvider
```
public SelectorProvider getSelectorProvider()
```
    Returns:
    
    the SelectorProvider that will be used by the created NIOTransport. If not explicitly set, then SelectorProvider.provider() will be used.
  - setSelectorProvider
```
public T setSelectorProvider(SelectorProvider selectorProvider)
```
    Set the SelectorProvider to be used by the created NIOTransport.
    
    Parameters:
    
    selectorProvider - the SelectorProvider.
    
    Returns:
    
    this NIOTransportBuilder
  - getName
```
public String getName()
```
    Returns:
    
    the Transport name
    
    See Also:
    
    Transport.getName()
  - setName
```
public T setName(String name)
```
    Parameters:
    
    name - the Transport name
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setName(String)
  - getProcessor
```
public Processor getProcessor()
```
    Returns:
    
    the default Processor if a Connection does not specify a preference
    
    See Also:
    
    Transport.getProcessor()
  - setProcessor
```
public T setProcessor(Processor processor)
```
    Parameters:
    
    processor - the default Processor if a Connection does not specify a preference
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setProcessor(Processor)
  - getProcessorSelector
```
public ProcessorSelector getProcessorSelector()
```
    Returns:
    
    the default ProcessorSelector
    
    See Also:
    
    Transport.getProcessorSelector()
  - setProcessorSelector
```
public T setProcessorSelector(ProcessorSelector processorSelector)
```
    Parameters:
    
    processorSelector - the default ProcessorSelector
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setProcessorSelector(ProcessorSelector)
  - getReadBufferSize
```
public int getReadBufferSize()
```
    Returns:
    
    the default buffer size
    
    See Also:
    
    Transport.getReadBufferSize()
  - setReadBufferSize
```
public T setReadBufferSize(int readBufferSize)
```
    Parameters:
    
    readBufferSize - the new buffer size
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setReadBufferSize(int)
  - getWriteBufferSize
```
public int getWriteBufferSize()
```
    Returns:
    
    the default buffer size
    
    See Also:
    
    Transport.getWriteBufferSize()
  - setWriteBufferSize
```
public T setWriteBufferSize(int writeBufferSize)
```
    Parameters:
    
    writeBufferSize - the new write buffer size
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setWriteBufferSize(int)
  - getClientSocketSoTimeout
```
public int getClientSocketSoTimeout()
```
    Returns:
    
    gets the timeout on socket blocking operations on the client
    
    See Also:
    
    Socket.getSoTimeout()
  - setClientSocketSoTimeout
```
public T setClientSocketSoTimeout(int clientSocketSoTimeout)
```
    Sets the timeout on socket blocking operations for the client
    
    Parameters:
    
    clientSocketSoTimeout - the specified timeout in milliseconds
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Socket.setSoTimeout(int)
  - getConnectionTimeout
```
public int getConnectionTimeout()
```
    Returns:
    
    value of the connectio timeout in milliseconds
    
    See Also:
    
    URLConnection.getConnectTimeout()
  - setConnectionTimeout
```
public T setConnectionTimeout(int connectionTimeout)
```
    Parameters:
    
    connectionTimeout - the value of the connection timeout in milliseconds
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    NIOTransport.setConnectionTimeout(int)
  - getReadTimeout
```
public long getReadTimeout(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit - the TimeUnit to convert the result to
    
    Returns:
    
    the blocking read timeout in the specified TimeUnit
    
    See Also:
    
    Transport.getReadTimeout(java.util.concurrent.TimeUnit)
  - setReadTimeout
```
public T setReadTimeout(long timeout,
                        TimeUnit timeUnit)
```
    Sets the value of the blocking read timeout
    
    Parameters:
    
    timeout - the new timeout value
    
    timeUnit - the unit of the new timeout value
    
    Returns:
    
    this NioTransportBuilder
    
    See Also:
    
    Transport.setReadTimeout(long, java.util.concurrent.TimeUnit)
  - getWriteTimeout
```
public long getWriteTimeout(TimeUnit timeUnit)
```
    Parameters:
    
    timeUnit - the TimeUnit to convert the result to
    
    Returns:
    
    the value of the write timeout
    
    See Also:
    
    Transport.getWriteTimeout(java.util.concurrent.TimeUnit)
  - setWriteTimeout
```
public T setWriteTimeout(long timeout,
                         TimeUnit timeUnit)
```
    Parameters:
    
    timeout - the new write timeout value
    
    timeUnit - the TimeUnit of the timeout value
    
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    Transport.setWriteTimeout(long, java.util.concurrent.TimeUnit)
  - isReuseAddress
```
public boolean isReuseAddress()
```
    Whether address may be reused for multiple sockets
    
    Returns:
    
    SO_REUSEADDR
    
    See Also:
    
    Socket man page
  - setReuseAddress
```
public T setReuseAddress(boolean reuseAddress)
```
    Sets whether address may be reused for multiple sockets
    
    Parameters:
    
    reuseAddress - SO_REUSEADDR
    
    Returns:
    
    this TCPNIOTransportBuilder
    
    See Also:
    
    Socket man page
  - getMaxAsyncWriteQueueSizeInBytes
```
public int getMaxAsyncWriteQueueSizeInBytes()
```
    Max asynchronous write queue size in bytes
    
    Returns:
    
    the value is per connection, not transport total.
    
    See Also:
    
    AsyncQueueWriter.getMaxPendingBytesPerConnection()
  - setMaxAsyncWriteQueueSizeInBytes
```
public T setMaxAsyncWriteQueueSizeInBytes(int maxAsyncWriteQueueSizeInBytes)
```
    Parameters:
    
    maxAsyncWriteQueueSizeInBytes - the value is per connection, not transport total.
    
    Returns:
    
    this TCPNIOTransportBuilder
    
    See Also:
    
    AsyncQueueWriter.setMaxPendingBytesPerConnection(int)
  - isOptimizedForMultiplexing
```
public boolean isOptimizedForMultiplexing()
```
    Returns:
    
    true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise.
    
    See Also:
    
    NIOTransport.isOptimizedForMultiplexing()
  - setOptimizedForMultiplexing
```
public T setOptimizedForMultiplexing(boolean optimizedForMultiplexing)
```
    Parameters:
    
    optimizedForMultiplexing - Configure NIOTransport to be optimized for connection multiplexing
    
    Returns:
    
    this TCPNIOTransportBuilder
    
    See Also:
    
    NIOTransport.setOptimizedForMultiplexing(boolean)
  - build
```
public NIOTransport build()
```
    Returns:
    
    an NIOTransport based on the builder's configuration.
  - getThis
```
protected abstract T getThis()
```
    Returns:
    
    this NIOTransportBuilder
    
    See Also:
    
    http://www.angelikalanger.com/GenericsFAQ/FAQSections/ProgrammingIdioms.html#FAQ205
  - create
```
protected abstract NIOTransport create(String name)
```

Class NIOTransportBuilder<T extends NIOTransportBuilder>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

transportClass

workerConfig

kernelConfig

selectorProvider

selectorHandler

selectionKeyHandler

memoryManager

attributeBuilder

ioStrategy

selectorRunnerCount

nioChannelDistributor

name

processor

processorSelector

readBufferSize

writeBufferSize

clientSocketSoTimeout

connectionTimeout

reuseAddress

maxPendingBytesPerConnection

optimizedForMultiplexing

readTimeout

writeTimeout

Constructor Detail

NIOTransportBuilder

Method Detail

getSelectorRunnersCount

setSelectorRunnersCount

getWorkerThreadPoolConfig

setWorkerThreadPoolConfig

getSelectorThreadPoolConfig

setSelectorThreadPoolConfig

getIOStrategy

setIOStrategy

getMemoryManager

setMemoryManager

getSelectorHandler

setSelectorHandler

getSelectionKeyHandler

setSelectionKeyHandler

getAttributeBuilder

setAttributeBuilder

getNIOChannelDistributor

setNIOChannelDistributor

getSelectorProvider

setSelectorProvider

getName

setName

getProcessor

setProcessor

getProcessorSelector

setProcessorSelector

getReadBufferSize

setReadBufferSize

getWriteBufferSize

setWriteBufferSize

getClientSocketSoTimeout

setClientSocketSoTimeout

getConnectionTimeout

setConnectionTimeout

getReadTimeout

setReadTimeout

getWriteTimeout

setWriteTimeout

isReuseAddress

setReuseAddress

getMaxAsyncWriteQueueSizeInBytes

setMaxAsyncWriteQueueSizeInBytes

isOptimizedForMultiplexing

setOptimizedForMultiplexing

build

getThis

create