Set the amount of time a client will wait for a connection from the pool. If the time is exceeded without a connection available, an exception is provided.
Set the time unit of PoolOptions
Set the number of event-loop the pool use.
0
, the client pool will use the current event-loopThe default size is 0
.
Establish an idle timeout for pooled connections, a value of zero disables the idle timeout.
Establish an idle timeout unit for pooled connections.
Establish a max lifetime for pooled connections, a value of zero disables the maximum lifetime.
Establish a max lifetime unit for pooled connections.
Set the maximum pool size
Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure. If the value is set to a negative number then the queue will be unbounded.
Set the pool name, used when the pool shared, otherwise ignored.
Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
Set to true
to share the pool.
There can be multiple shared pools distinguished by PoolOptions, when no specific name is set, the PoolOptions is used.
Set the amount of time a client will wait for a connection from the pool. If the time is exceeded without a connection available, an exception is provided.
Set the time unit of PoolOptions
Set the number of event-loop the pool use.
0
, the client pool will use the current event-loopThe default size is 0
.
Establish an idle timeout for pooled connections, a value of zero disables the idle timeout.
Establish an idle timeout unit for pooled connections.
Establish a max lifetime for pooled connections, a value of zero disables the maximum lifetime.
Establish a max lifetime unit for pooled connections.
Set the maximum pool size
Set the maximum connection request allowed in the wait queue, any requests beyond the max size will result in an failure. If the value is set to a negative number then the queue will be unbounded.
Set the pool name, used when the pool shared, otherwise ignored.
Set the connection pool cleaner period in milli seconds, a non positive value disables expiration checks and connections will remain in the pool until they are closed.
Set to true
to share the pool.
There can be multiple shared pools distinguished by PoolOptions, when no specific name is set, the PoolOptions is used.
Generated using TypeDoc
The options for configuring a connection pool.