org.glassfish.grizzly.connectionpool

Class SingleEndpointPool.Builder<E>

java.lang.Object

org.glassfish.grizzly.connectionpool.SingleEndpointPool.Builder<E>

Type Parameters:

E - endpoint address type, for example SocketAddress for TCP and UDP transports

Enclosing class:

SingleEndpointPool<E>

public static class SingleEndpointPool.Builder<E>
extends Object

The Builder class responsible for constructing SingleEndpointPool.

Constructor Summary

Constructors

Constructor and Description
SingleEndpointPool.Builder()

Method Summary

Methods

Modifier and Type	Method and Description
SingleEndpointPool<E>	build() Constructs SingleEndpointPool.
SingleEndpointPool.Builder<E>	connectorHandler(ConnectorHandler<E> connectorHandler) Sets the ConnectorHandler used to establish new Connections.
SingleEndpointPool.Builder<E>	connectTimeout(long connectTimeout, TimeUnit timeunit) Sets the max time Connection connect operation may take.
SingleEndpointPool.Builder<E>	corePoolSize(int corePoolSize) Sets the number of Connections, kept in the pool, that are immune to keep-alive mechanism.
SingleEndpointPool.Builder<E>	delayExecutor(DelayedExecutor delayedExecutor) Sets the custom DelayedExecutor to be used for keep-alive and reconnect mechanisms.
SingleEndpointPool.Builder<E>	endpointAddress(E endpointAddress) Sets the endpoint address.
SingleEndpointPool.Builder<E>	keepAliveCheckInterval(long keepAliveCheckInterval, TimeUnit timeunit) Sets the interval, which specifies how often the pool will perform idle Connections check.
SingleEndpointPool.Builder<E>	keepAliveTimeout(long keepAliveTimeout, TimeUnit timeunit) Sets the maximum number of milliseconds an idle Connection will be kept in the pool.
SingleEndpointPool.Builder<E>	localEndpointAddress(E localEndpointAddress) Sets the local endpoint address.
SingleEndpointPool.Builder<E>	maxPoolSize(int maxPoolSize) Sets the max number of Connections kept by this pool.
SingleEndpointPool.Builder<E>	maxReconnectAttempts(int maxReconnectAttempts) If the reconnect mechanism is enabled, then this property will affect how many times a reconnection attempt can be made consecutively before a failure is flagged.
SingleEndpointPool.Builder<E>	reconnectDelay(long reconnectDelay, TimeUnit timeunit) Sets the delay to be used before the pool will repeat the attempt to connect to the endpoint after previous connect operation had failed.

Methods inherited from class java.lang.Object

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

Constructor Detail

SingleEndpointPool.Builder

public SingleEndpointPool.Builder()

Method Detail

connectorHandler

public SingleEndpointPool.Builder<E> connectorHandler(ConnectorHandler<E> connectorHandler)

Sets the ConnectorHandler used to establish new Connections.

Parameters:

connectorHandler - ConnectorHandler

Returns:

this SingleEndpointPool.Builder

endpointAddress

public SingleEndpointPool.Builder<E> endpointAddress(E endpointAddress)

Sets the endpoint address.

Parameters:

endpointAddress -

Returns:

this SingleEndpointPool.Builder

localEndpointAddress

public SingleEndpointPool.Builder<E> localEndpointAddress(E localEndpointAddress)

Sets the local endpoint address.

Returns:

this SingleEndpointPool.Builder

corePoolSize

public SingleEndpointPool.Builder<E> corePoolSize(int corePoolSize)

Sets the number of Connections, kept in the pool, that are immune to keep-alive mechanism. Default value is 0.

Parameters:

corePoolSize -

Returns:

this SingleEndpointPool.Builder

maxPoolSize

public SingleEndpointPool.Builder<E> maxPoolSize(int maxPoolSize)

Sets the max number of Connections kept by this pool. Default value is 4.

Parameters:

maxPoolSize -

Returns:

this SingleEndpointPool.Builder

delayExecutor

public SingleEndpointPool.Builder<E> delayExecutor(DelayedExecutor delayedExecutor)

Sets the custom DelayedExecutor to be used for keep-alive and reconnect mechanisms. If none is set - the SingleEndpointPool will create its own DelayedExecutor.

Parameters:

delayedExecutor -

Returns:

this SingleEndpointPool.Builder

connectTimeout

public SingleEndpointPool.Builder<E> connectTimeout(long connectTimeout,
                                           TimeUnit timeunit)

Sets the max time Connection connect operation may take. If timeout expires - the connect operation is considered failed. If connectTimeout < 0 - the connect timeout mechanism will be disabled. By default the connect timeout mechanism is disabled.

Parameters:

connectTimeout - the max time Connection connect operation may take. If timeout expires - the connect operation is considered failed. The negative value disables the connect timeout mechanism.

timeunit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this SingleEndpointPool.Builder

reconnectDelay

public SingleEndpointPool.Builder<E> reconnectDelay(long reconnectDelay,
                                           TimeUnit timeunit)

Sets the delay to be used before the pool will repeat the attempt to connect to the endpoint after previous connect operation had failed. If reconnectDelay < 0 - the reconnect mechanism will be disabled. By default the reconnect mechanism is disabled.

Parameters:

reconnectDelay - the delay to be used before the pool will repeat the attempt to connect to the endpoint after previous connect operation had failed. The negative value disables the reconnect mechanism.

timeunit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this SingleEndpointPool.Builder

maxReconnectAttempts

public SingleEndpointPool.Builder<E> maxReconnectAttempts(int maxReconnectAttempts)

If the reconnect mechanism is enabled, then this property will affect how many times a reconnection attempt can be made consecutively before a failure is flagged.

Parameters:

maxReconnectAttempts - the maximum number of reconnect attempts. If the reconnect mechanism isn't enabled, this property is ignored.

Returns:

this SingleEndpointPool.Builder

keepAliveTimeout

public SingleEndpointPool.Builder<E> keepAliveTimeout(long keepAliveTimeout,
                                             TimeUnit timeunit)

Sets the maximum number of milliseconds an idle Connection will be kept in the pool. The idle Connections will be closed till the pool size is greater than corePoolSize. If keepAliveTimeout < 0 - the keep-alive mechanism will be disabled. By default the keep-alive timeout is set to 30 seconds.

Parameters:

keepAliveTimeout - the maximum number of milliseconds an idle Connection will be kept in the pool. The negative value disables the keep-alive mechanism.

timeunit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this SingleEndpointPool.Builder

keepAliveCheckInterval

public SingleEndpointPool.Builder<E> keepAliveCheckInterval(long keepAliveCheckInterval,
                                                   TimeUnit timeunit)

Sets the interval, which specifies how often the pool will perform idle Connections check.

Parameters:

keepAliveCheckInterval - the interval, which specifies how often the pool will perform idle Connections check

timeunit - a TimeUnit determining how to interpret the timeout parameter

Returns:

this SingleEndpointPool.Builder

build

public SingleEndpointPool<E> build()

Constructs SingleEndpointPool.

Returns:

SingleEndpointPool