Grizzly NIO 5.0.2 · org.glassfish.grizzly.NIOTransportBuilder

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<E extends Buffer>	memoryManager
protected String	name
protected NIOChannelDistributor	nioChannelDistributor
protected boolean	optimizedForMultiplexing
protected Processor<E extends Context>	processor
protected ProcessorSelector	processorSelector
protected int	readBufferSize
protected long	readTimeout
protected boolean	reuseAddress
protected boolean	reusePort
protected SelectionKeyHandler	selectionKeyHandler
protected SelectorHandler	selectorHandler
protected SelectorProvider	selectorProvider
protected int	selectorRunnerCount
protected final Class<? extends NIOTransport>	transportClass
protected ThreadPoolConfig	workerConfig
protected int	writeBufferSize
protected long	writeTimeout

Access	Constructor and Description
protected	NIOTransportBuilder(final Class<? extends NIOTransport> the class of the `NIOTransport` implementation to be used. transportClass) Constructs a new `NIOTransport` using the given `transportClass` and `IOStrategy`.

Method Summary

Modifier and Type	Method and Description
public NIOTransport	build() Returns: an `NIOTransport` based on the builder's configuration.
protected abstract NIOTransport	create(String name)
public AttributeBuilder	getAttributeBuilder() Returns: the `AttributeBuilder` that will be used by the created `NIOTransport`.
public int	getClientSocketSoTimeout() Returns: gets the timeout on socket blocking operations on the client
public int	getConnectionTimeout() Returns: value of the connectio timeout in milliseconds
public IOStrategy	getIOStrategy() Returns: the `IOStrategy` that will be used by the created `NIOTransport`.
public int	Returns: the value is per connection, not transport total. getMaxAsyncWriteQueueSizeInBytes() Max asynchronous write queue size in bytes
public MemoryManager<E extends Buffer>	getMemoryManager() Returns: the `MemoryManager` that will be used by the created `NIOTransport`.
public String	getName() Returns: the Transport name
public NIOChannelDistributor	getNIOChannelDistributor() Returns: the `NIOChannelDistributor` that will be used by the created `NIOTransport`.
public Processor<E extends Context>	getProcessor() Returns: the default `Processor` if a `Connection` does not specify a preference
public ProcessorSelector	getProcessorSelector() Returns: the default `ProcessorSelector`
public int	getReadBufferSize() Returns: the default buffer size
public long	getReadTimeout(final TimeUnit the `TimeUnit` to convert the result to timeUnit) Returns: the blocking read timeout in the specified `TimeUnit`
public SelectionKeyHandler	getSelectionKeyHandler() Returns: the `SelectionKeyHandler` that will be used by the created `NIOTransport`.
public SelectorHandler	getSelectorHandler() Returns: the `SelectorHandler` that will be used by the created `NIOTransport`.
public SelectorProvider	getSelectorProvider() Returns: the `SelectorProvider` that will be used by the created `NIOTransport`.
public int	getSelectorRunnersCount() Returns: the number of `java.nio.channels.Selector`s to be created to serve Transport connections.
public ThreadPoolConfig	getSelectorThreadPoolConfig() Returns: the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` which will run the `NIOTransport`'s `org.glassfish.grizzly.nio.SelectorRunner`s.
protected abstract T	getThis() Returns: this NIOTransportBuilder
public ThreadPoolConfig	getWorkerThreadPoolConfig() Returns: the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` for `IOStrategies` that require worker threads.
public int	getWriteBufferSize() Returns: the default buffer size
public long	getWriteTimeout(final TimeUnit the `TimeUnit` to convert the result to timeUnit) Returns: the value of the write timeout
public boolean	isOptimizedForMultiplexing() Returns: true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise.
public boolean	Returns: SO_REUSEADDR isReuseAddress() Whether address may be reused for multiple sockets
public boolean	Returns: SO_REUSEPORT isReusePort() Whether both same address and same port may be reused for multiple sockets
public T	Returns: this `NIOTransportBuilder` setAttributeBuilder(AttributeBuilder the `AttributeBuilder`. attributeBuilder) Set the `AttributeBuilder` to be used by the created `NIOTransport`.
public T	Returns: this `NIOTransportBuilder` setClientSocketSoTimeout(int the specified timeout in milliseconds clientSocketSoTimeout) Sets the timeout on socket blocking operations for the client
public T	setConnectionTimeout(int the value of the connection timeout in milliseconds connectionTimeout) Returns: this `NIOTransportBuilder`
public T	Returns: this `NIOTransportBuilder` setIOStrategy(final IOStrategy the `IOStrategy` to use. ioStrategy) Changes the `IOStrategy` that will be used.
public T	setMaxAsyncWriteQueueSizeInBytes(final int the value is per connection, not transport total. maxAsyncWriteQueueSizeInBytes) Returns: this `TCPNIOTransportBuilder`
public T	Returns: this `NIOTransportBuilder` setMemoryManager(final MemoryManager<E extends Buffer> the `MemoryManager`. memoryManager) Set the `MemoryManager` to be used by the created `NIOTransport`.
public T	setName(String the `Transport` name name) Returns: this `NIOTransportBuilder`
public T	Returns: this `NIOTransportBuilder` setNIOChannelDistributor(NIOChannelDistributor the `NIOChannelDistributor`. nioChannelDistributor) Set the `NIOChannelDistributor` to be used by the created `NIOTransport`.
public T	setOptimizedForMultiplexing(final boolean Configure NIOTransport to be optimized for connection multiplexing optimizedForMultiplexing) Returns: this `TCPNIOTransportBuilder`
public T	setProcessor(Processor<E extends Context> the default `Processor` if a `Connection` does not specify a preference processor) Returns: this `NIOTransportBuilder`
public T	setProcessorSelector(ProcessorSelector the default `ProcessorSelector` processorSelector) Returns: this `NIOTransportBuilder`
public T	setReadBufferSize(int the new buffer size readBufferSize) Returns: this `NIOTransportBuilder`
public T	Returns: this NioTransportBuilder setReadTimeout(final long the new timeout value timeout, final TimeUnit the unit of the new timeout value timeUnit) Sets the value of the blocking read timeout
public T	Returns: this `TCPNIOTransportBuilder` setReuseAddress(boolean SO_REUSEADDR reuseAddress) Sets whether address may be reused for multiple sockets
public T	Returns: this `TCPNIOTransportBuilder` setReusePort(boolean SO_REUSEPORT reusePort) Sets whether both same address and same port may be reused for multiple sockets
public T	Returns: this `NIOTransportBuilder` setSelectionKeyHandler(final SelectionKeyHandler the `SelectionKeyHandler`. selectionKeyHandler) Set the `SelectionKeyHandler` to be used by the created `NIOTransport`.
public T	Returns: this `NIOTransportBuilder` setSelectorHandler(final SelectorHandler the `SelectorHandler`. selectorHandler) Set the `SelectorHandler` to be used by the created `NIOTransport`.
public T	Returns: this `NIOTransportBuilder` setSelectorProvider(SelectorProvider the `SelectorProvider`. selectorProvider) Set the `SelectorProvider` to be used by the created `NIOTransport`.
public T	Returns: the builder setSelectorRunnersCount(final int number of channels selectorRunnersCount) Sets the number of `java.nio.channels.Selector`s to be created to serve Transport connections.
public T	Returns: this builder setSelectorThreadPoolConfig(final ThreadPoolConfig the config kernelConfig) Sets the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` which will run the `NIOTransport`'s `org.glassfish.grizzly.nio.SelectorRunner`s.
public T	Returns: this builder setWorkerThreadPoolConfig(final ThreadPoolConfig the config workerConfig) Sets the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` for `IOStrategies` that require worker threads
public T	setWriteBufferSize(int the new write buffer size writeBufferSize) Returns: this `NIOTransportBuilder`
public T	setWriteTimeout(final long the new write timeout value timeout, final TimeUnit the `TimeUnit` of the timeout value timeUnit) Returns: this NIOTransportBuilder

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

attributeBuilder	back to summary
protected AttributeBuilder attributeBuilder

clientSocketSoTimeout	back to summary
protected int clientSocketSoTimeout

connectionTimeout	back to summary
protected int connectionTimeout

ioStrategy	back to summary
protected IOStrategy ioStrategy

kernelConfig	back to summary
protected ThreadPoolConfig kernelConfig

maxPendingBytesPerConnection	back to summary
protected int maxPendingBytesPerConnection

memoryManager	back to summary
protected MemoryManager<E extends Buffer> memoryManager

name	back to summary
protected String name

nioChannelDistributor	back to summary
protected NIOChannelDistributor nioChannelDistributor

optimizedForMultiplexing	back to summary
protected boolean optimizedForMultiplexing

processor	back to summary
protected Processor<E extends Context> processor

processorSelector	back to summary
protected ProcessorSelector processorSelector

readBufferSize	back to summary
protected int readBufferSize

readTimeout	back to summary
protected long readTimeout

reuseAddress	back to summary
protected boolean reuseAddress

reusePort	back to summary
protected boolean reusePort

selectionKeyHandler	back to summary
protected SelectionKeyHandler selectionKeyHandler

selectorHandler	back to summary
protected SelectorHandler selectorHandler

selectorProvider	back to summary
protected SelectorProvider selectorProvider

selectorRunnerCount	back to summary
protected int selectorRunnerCount

transportClass	back to summary
protected final Class<? extends NIOTransport> transportClass

workerConfig	back to summary
protected ThreadPoolConfig workerConfig

writeBufferSize	back to summary
protected int writeBufferSize

writeTimeout	back to summary
protected long writeTimeout

NIOTransportBuilder	back to summary
protected NIOTransportBuilder(final 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 `IOStrategy#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:Class<? extends NIOTransport> the class of the `NIOTransport` implementation to be used.

Method Detail

build	back to summary
public NIOTransport build() Returns:NIOTransport an `NIOTransport` based on the builder's configuration.

create	back to summary
protected abstract NIOTransport create(String name)

getAttributeBuilder	back to summary
public AttributeBuilder getAttributeBuilder() Returns:AttributeBuilder the `AttributeBuilder` that will be used by the created `NIOTransport`. If not explicitly set, then `AttributeBuilder#DEFAULT_ATTRIBUTE_BUILDER` will be used.

getClientSocketSoTimeout	back to summary
public int getClientSocketSoTimeout() Returns:int gets the timeout on socket blocking operations on the client See Also `java.net.Socket#getSoTimeout()`

getConnectionTimeout	back to summary
public int getConnectionTimeout() Returns:int value of the connectio timeout in milliseconds See Also `java.net.URLConnection#getConnectTimeout()`

getIOStrategy	back to summary
public IOStrategy getIOStrategy() Returns:IOStrategy the `IOStrategy` that will be used by the created `NIOTransport`.

getMaxAsyncWriteQueueSizeInBytes back to summary

getMaxAsyncWriteQueueSizeInBytes	back to summary
public int getMaxAsyncWriteQueueSizeInBytes() Max asynchronous write queue size in bytes Returns:int the value is per connection, not transport total. See Also `org.glassfish.grizzly.asyncqueue.AsyncQueueWriter#getMaxPendingBytesPerConnection()`

public int getMaxAsyncWriteQueueSizeInBytes()

Max asynchronous write queue size in bytes

Returns:int: the value is per connection, not transport total.
See Also: org.glassfish.grizzly.asyncqueue.AsyncQueueWriter#getMaxPendingBytesPerConnection()

getMemoryManager	back to summary
public MemoryManager<E extends Buffer> getMemoryManager() Returns:MemoryManager<E extends Buffer> the `MemoryManager` that will be used by the created `NIOTransport`. If not explicitly set, then `MemoryManager#DEFAULT_MEMORY_MANAGER` will be used.

getName	back to summary
public String getName() Returns:String the Transport name See Also `Transport#getName()`

getNIOChannelDistributor	back to summary
public NIOChannelDistributor getNIOChannelDistributor() Returns:NIOChannelDistributor the `NIOChannelDistributor` that will be used by the created `NIOTransport`. If not explicitly set, then `AttributeBuilder#DEFAULT_ATTRIBUTE_BUILDER` will be used.

getProcessor	back to summary
public Processor<E extends Context> getProcessor() Returns:Processor<E extends Context> the default `Processor` if a `Connection` does not specify a preference See Also `Transport#getProcessor()`

getProcessorSelector	back to summary
public ProcessorSelector getProcessorSelector() Returns:ProcessorSelector the default `ProcessorSelector` See Also `Transport#getProcessorSelector()`

getReadBufferSize	back to summary
public int getReadBufferSize() Returns:int the default buffer size See Also `Transport#getReadBufferSize()`

getReadTimeout	back to summary
public long getReadTimeout(final TimeUnit timeUnit) Parameters timeUnit:TimeUnit the `TimeUnit` to convert the result to Returns:long the blocking read timeout in the specified `TimeUnit` See Also `Transport#getReadTimeout(java.util.concurrent.TimeUnit)`

getSelectionKeyHandler	back to summary
public SelectionKeyHandler getSelectionKeyHandler() Returns:SelectionKeyHandler the `SelectionKeyHandler` that will be used by the created `NIOTransport`. If not explicitly set, then `SelectionKeyHandler#DEFAULT_SELECTION_KEY_HANDLER` will be used.

getSelectorHandler	back to summary
public SelectorHandler getSelectorHandler() Returns:SelectorHandler the `SelectorHandler` that will be used by the created `NIOTransport`. If not explicitly set, then `SelectorHandler#DEFAULT_SELECTOR_HANDLER` will be used.

getSelectorProvider	back to summary
public SelectorProvider getSelectorProvider() Returns:SelectorProvider the `SelectorProvider` that will be used by the created `NIOTransport`. If not explicitly set, then `SelectorProvider#provider()` will be used.

getSelectorRunnersCount	back to summary
public int getSelectorRunnersCount() Returns:int the number of `java.nio.channels.Selector`s 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()`

getSelectorThreadPoolConfig	back to summary
public ThreadPoolConfig getSelectorThreadPoolConfig() Returns:ThreadPoolConfig the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` which will run the `NIOTransport`'s `org.glassfish.grizzly.nio.SelectorRunner`s.

getThis	back to summary
protected abstract T getThis() Returns:T this NIOTransportBuilder See Also http://www.angelikalanger.com/GenericsFAQ/FAQSections/ProgrammingIdioms.html#FAQ205

getWorkerThreadPoolConfig	back to summary
public ThreadPoolConfig getWorkerThreadPoolConfig() Returns:ThreadPoolConfig the `ThreadPoolConfig` that will be used to construct the `java.util.concurrent.ExecutorService` for `IOStrategies` that require worker threads. This method will return `null` if a `ThreadPoolConfig` had not been previously set.

getWriteBufferSize	back to summary
public int getWriteBufferSize() Returns:int the default buffer size See Also `Transport#getWriteBufferSize()`

getWriteTimeout	back to summary
public long getWriteTimeout(final TimeUnit timeUnit) Parameters timeUnit:TimeUnit the `TimeUnit` to convert the result to Returns:long the value of the write timeout See Also `Transport#getWriteTimeout(java.util.concurrent.TimeUnit)`

isOptimizedForMultiplexing	back to summary
public boolean isOptimizedForMultiplexing() Returns:boolean true, if NIOTransport is configured to use AsyncQueueWriter, optimized to be used in connection multiplexing mode, or false otherwise. See Also `org.glassfish.grizzly.nio.NIOTransport#isOptimizedForMultiplexing()`

isReuseAddress

back to summary

public boolean isReuseAddress()

Whether address may be reused for multiple sockets

Returns:boolean: SO_REUSEADDR
See Also: Socket man page

isReusePort

back to summary

public boolean isReusePort()

Whether both same address and same port may be reused for multiple sockets

Returns:boolean: SO_REUSEPORT
See Also: Socket man page

setAttributeBuilder back to summary

public T setAttributeBuilder(AttributeBuilder attributeBuilder)

Set the AttributeBuilder to be used by the created NIOTransport.

Parameters

attributeBuilder:AttributeBuilder: the AttributeBuilder.

Returns:T

this NIOTransportBuilder

setClientSocketSoTimeout back to summary

public T setClientSocketSoTimeout(int clientSocketSoTimeout)

Sets the timeout on socket blocking operations for the client

Parameters

clientSocketSoTimeout:int: the specified timeout in milliseconds

Returns:T

this NIOTransportBuilder

See Also

java.net.Socket#setSoTimeout(int)

setConnectionTimeout	back to summary
public T setConnectionTimeout(int connectionTimeout) Parameters connectionTimeout:int the value of the connection timeout in milliseconds Returns:T this `NIOTransportBuilder` See Also `NIOTransport#setConnectionTimeout(int)`

setIOStrategy back to summary

public T setIOStrategy(final IOStrategy ioStrategy)

Changes the IOStrategy that will be used. Invoking this method may change the return value of getWorkerThreadPoolConfig()

Parameters

ioStrategy:IOStrategy: the IOStrategy to use.

Returns:T

this NIOTransportBuilder

setMaxAsyncWriteQueueSizeInBytes	back to summary
public T setMaxAsyncWriteQueueSizeInBytes(final int maxAsyncWriteQueueSizeInBytes) Parameters maxAsyncWriteQueueSizeInBytes:int the value is per connection, not transport total. Returns:T this `TCPNIOTransportBuilder` See Also `org.glassfish.grizzly.asyncqueue.AsyncQueueWriter#setMaxPendingBytesPerConnection(int)`

setMemoryManager back to summary

public T setMemoryManager(final MemoryManager<E extends Buffer> memoryManager)

Set the MemoryManager to be used by the created NIOTransport.

Parameters

memoryManager:MemoryManager<E extends Buffer>: the MemoryManager.

Returns:T

this NIOTransportBuilder

setName	back to summary
public T setName(String name) Parameters name:String the `Transport` name Returns:T this `NIOTransportBuilder` See Also `Transport#setName(String)`

setNIOChannelDistributor back to summary

public T setNIOChannelDistributor(NIOChannelDistributor nioChannelDistributor)

Set the NIOChannelDistributor to be used by the created NIOTransport.

Parameters

nioChannelDistributor:NIOChannelDistributor: the NIOChannelDistributor.

Returns:T

this NIOTransportBuilder

setOptimizedForMultiplexing	back to summary
public T setOptimizedForMultiplexing(final boolean optimizedForMultiplexing) Parameters optimizedForMultiplexing:boolean Configure NIOTransport to be optimized for connection multiplexing Returns:T this `TCPNIOTransportBuilder` See Also `org.glassfish.grizzly.nio.NIOTransport#setOptimizedForMultiplexing(boolean)`

setProcessor	back to summary
public T setProcessor(Processor<E extends Context> processor) Parameters processor:Processor<E extends Context> the default `Processor` if a `Connection` does not specify a preference Returns:T this `NIOTransportBuilder` See Also `Transport#setProcessor(Processor)`

setProcessorSelector	back to summary
public T setProcessorSelector(ProcessorSelector processorSelector) Parameters processorSelector:ProcessorSelector the default `ProcessorSelector` Returns:T this `NIOTransportBuilder` See Also `Transport#setProcessorSelector(ProcessorSelector)`

setReadBufferSize	back to summary
public T setReadBufferSize(int readBufferSize) Parameters readBufferSize:int the new buffer size Returns:T this `NIOTransportBuilder` See Also `Transport#setReadBufferSize(int)`

setReadTimeout back to summary

public T setReadTimeout(final long timeout, final TimeUnit timeUnit)

Sets the value of the blocking read timeout

Parameters

timeout:long: the new timeout value
timeUnit:TimeUnit: the unit of the new timeout value

Returns:T

this NioTransportBuilder

setReuseAddress back to summary

public T setReuseAddress(boolean reuseAddress)

Sets whether address may be reused for multiple sockets

Parameters

reuseAddress:boolean: SO_REUSEADDR

Returns:T

this TCPNIOTransportBuilder

See Also

Socket man page

setReusePort back to summary

public T setReusePort(boolean reusePort)

Sets whether both same address and same port may be reused for multiple sockets

Parameters

reusePort:boolean: SO_REUSEPORT

Returns:T

this TCPNIOTransportBuilder

See Also

Socket man page

setSelectionKeyHandler back to summary

public T setSelectionKeyHandler(final SelectionKeyHandler selectionKeyHandler)

Set the SelectionKeyHandler to be used by the created NIOTransport.

Parameters

selectionKeyHandler:SelectionKeyHandler: the SelectionKeyHandler.

Returns:T

this NIOTransportBuilder

setSelectorHandler back to summary

public T setSelectorHandler(final SelectorHandler selectorHandler)

Set the SelectorHandler to be used by the created NIOTransport.

Parameters

selectorHandler:SelectorHandler: the SelectorHandler.

Returns:T

this NIOTransportBuilder

setSelectorProvider back to summary

public T setSelectorProvider(SelectorProvider selectorProvider)

Set the SelectorProvider to be used by the created NIOTransport.

Parameters

selectorProvider:SelectorProvider: the SelectorProvider.

Returns:T

this NIOTransportBuilder

setSelectorRunnersCount back to summary

public T setSelectorRunnersCount(final int selectorRunnersCount)

Sets the number of java.nio.channels.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:int: number of channels

Returns:T

the builder

setSelectorThreadPoolConfig back to summary

public T setSelectorThreadPoolConfig(final ThreadPoolConfig kernelConfig)

Sets the ThreadPoolConfig that will be used to construct the java.util.concurrent.ExecutorService which will run the NIOTransport's org.glassfish.grizzly.nio.SelectorRunners.

Parameters

kernelConfig:ThreadPoolConfig: the config

Returns:T

this builder

setWorkerThreadPoolConfig back to summary

public T setWorkerThreadPoolConfig(final ThreadPoolConfig workerConfig)

Sets the ThreadPoolConfig that will be used to construct the java.util.concurrent.ExecutorService for IOStrategies that require worker threads

Parameters

workerConfig:ThreadPoolConfig: the config

Returns:T

this builder

setWriteBufferSize	back to summary
public T setWriteBufferSize(int writeBufferSize) Parameters writeBufferSize:int the new write buffer size Returns:T this `NIOTransportBuilder` See Also `Transport#setWriteBufferSize(int)`

setWriteTimeout	back to summary
public T setWriteTimeout(final long timeout, final TimeUnit timeUnit) Parameters timeout:long the new write timeout value timeUnit:TimeUnit the `TimeUnit` of the timeout value Returns:T this NIOTransportBuilder See Also `Transport#setWriteTimeout(long, java.util.concurrent.TimeUnit)`

public abstract Class NIOTransportBuilder<T extends NIOTransportBuilder>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail