com.rabbitmq.client.impl.nio

Class NioParams

java.lang.Object

com.rabbitmq.client.impl.nio.NioParams

public class NioParams
extends Object

Parameters used to configure the NIO mode of a ConnectionFactory.

Constructor Summary

Constructors

Constructor and Description
NioParams()
NioParams(NioParams nioParams)

Method Summary

Modifier and Type	Method and Description
int	getNbIoThreads()
ExecutorService	getNioExecutor()
int	getReadByteBufferSize()
SocketChannelConfigurator	getSocketChannelConfigurator()
SslEngineConfigurator	getSslEngineConfigurator()
ThreadFactory	getThreadFactory()
int	getWriteByteBufferSize()
int	getWriteEnqueuingTimeoutInMs()
int	getWriteQueueCapacity()
NioParams	setNbIoThreads(int nbIoThreads) Sets the max number of threads/tasks used for NIO.
NioParams	setNioExecutor(ExecutorService nioExecutor) Sets the ExecutorService to use for NIO threads/tasks.
NioParams	setReadByteBufferSize(int readByteBufferSize) Sets the size in byte of the read ByteBuffer used in the NIO loop.
void	setSocketChannelConfigurator(SocketChannelConfigurator configurator) Set the SocketChannel configurator.
void	setSslEngineConfigurator(SslEngineConfigurator configurator) Set the SSLEngine configurator.
NioParams	setThreadFactory(ThreadFactory threadFactory) Sets the ThreadFactory to use for NIO threads/tasks.
NioParams	setWriteByteBufferSize(int writeByteBufferSize) Sets the size in byte of the write ByteBuffer used in the NIO loop.
NioParams	setWriteEnqueuingTimeoutInMs(int writeEnqueuingTimeoutInMs) Sets the timeout for queuing outbound frames.
NioParams	setWriteQueueCapacity(int writeQueueCapacity) Set the capacity of the queue used for outbound frames.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NioParams

public NioParams()

NioParams

public NioParams(NioParams nioParams)

Method Detail

getReadByteBufferSize

public int getReadByteBufferSize()

setReadByteBufferSize

public NioParams setReadByteBufferSize(int readByteBufferSize)

Sets the size in byte of the read ByteBuffer used in the NIO loop. Default is 32768. This parameter isn't used when using SSL/TLS, where ByteBuffer size is set up according to the SSLSession packet size.

Parameters:

readByteBufferSize - size of the ByteBuffer for inbound data

Returns:

this NioParams instance

getWriteByteBufferSize

public int getWriteByteBufferSize()

setWriteByteBufferSize

public NioParams setWriteByteBufferSize(int writeByteBufferSize)

Sets the size in byte of the write ByteBuffer used in the NIO loop. Default is 32768. This parameter isn't used when using SSL/TLS, where ByteBuffer size is set up according to the SSLSession packet size.

Parameters:

writeByteBufferSize - size of the ByteBuffer used for outbound data

Returns:

this NioParams instance

getNbIoThreads

public int getNbIoThreads()

setNbIoThreads

public NioParams setNbIoThreads(int nbIoThreads)

Sets the max number of threads/tasks used for NIO. Default is 1. Set this number according to the number of simultaneous connections and their activity. Threads/tasks are created as necessary (e.g. with 10 threads, when 10 connections have been created). Once a connection is created, it's assigned to a thread/task and all its IO activity is handled by this thread/task. When idle for a few seconds (i.e. without any connection to perform IO for), a thread/task stops and is recreated if necessary.

Parameters:

nbIoThreads -

Returns:

this NioParams instance

getWriteEnqueuingTimeoutInMs

public int getWriteEnqueuingTimeoutInMs()

setWriteEnqueuingTimeoutInMs

public NioParams setWriteEnqueuingTimeoutInMs(int writeEnqueuingTimeoutInMs)

Sets the timeout for queuing outbound frames. Default is 10,000 ms. Every requests to the server is divided into frames that are then queued in a BlockingQueue before being sent on the network by a IO thread. If the IO thread cannot cope with the frames dispatch, the BlockingQueue gets filled up and blocks (blocking the calling thread by the same occasion). This timeout is the time the BlockingQueue will wait before rejecting the outbound frame. The calling thread will then received an exception. The appropriate value depends on the application scenarios: rate of outbound data (published messages, acknowledgment, etc), network speed...

Parameters:

writeEnqueuingTimeoutInMs -

Returns:

this NioParams instance

See Also:

setWriteQueueCapacity(int)

getNioExecutor

public ExecutorService getNioExecutor()

setNioExecutor

public NioParams setNioExecutor(ExecutorService nioExecutor)

Sets the ExecutorService to use for NIO threads/tasks. Default is to use the thread factory. The ExecutorService should be able to run the number of requested IO threads, plus a few more, as it's also used to dispatch the shutdown of connections. It's developer's responsibility to shut down the executor when it is no longer needed. The thread factory isn't used if an executor service is set up.

Parameters:

nioExecutor - ExecutorService used for IO threads and connection shutdown

Returns:

this NioParams instance

See Also:

setNbIoThreads(int), setThreadFactory(ThreadFactory)

getThreadFactory

public ThreadFactory getThreadFactory()

setThreadFactory

public NioParams setThreadFactory(ThreadFactory threadFactory)

Sets the ThreadFactory to use for NIO threads/tasks. Default is to use the ConnectionFactory's ThreadFactory. The ThreadFactory is used to spawn the IO threads and dispatch the shutdown of connections.

Parameters:

threadFactory - ThreadFactory used for IO threads and connection shutdown

Returns:

this NioParams instance

See Also:

setNbIoThreads(int), setNioExecutor(ExecutorService)

getWriteQueueCapacity

public int getWriteQueueCapacity()

setWriteQueueCapacity

public NioParams setWriteQueueCapacity(int writeQueueCapacity)

Set the capacity of the queue used for outbound frames. Default capacity is 10,000.

Parameters:

writeQueueCapacity -

Returns:

this NioParams instance

See Also:

setWriteEnqueuingTimeoutInMs(int)

setSocketChannelConfigurator

public void setSocketChannelConfigurator(SocketChannelConfigurator configurator)

Set the SocketChannel configurator. This gets a chance to "configure" a socket channel before it has been opened. The default implementation disables Nagle's algorithm.

Parameters:

configurator - the configurator to use

getSocketChannelConfigurator

public SocketChannelConfigurator getSocketChannelConfigurator()

setSslEngineConfigurator

public void setSslEngineConfigurator(SslEngineConfigurator configurator)

Set the SSLEngine configurator. This gets a change to "configure" the SSL engine before the connection has been opened. This can be used e.g. to set SSLParameters. The default implementation doesn't do anything.

Parameters:

configurator - the configurator to use

getSslEngineConfigurator

public SslEngineConfigurator getSslEngineConfigurator()