io.vertx.redis.client

Class PoolOptions

java.lang.Object

io.vertx.redis.client.PoolOptions

public class PoolOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
PoolOptions()
PoolOptions(JsonObject json)
PoolOptions(PoolOptions other)

Method Summary

Modifier and Type	Method and Description
int	getCleanerInterval() Tune how often in milliseconds should the connection pool cleaner execute.
int	getMaxSize() Tune the maximum size of the connection pool.
int	getMaxWaiting() Tune the maximum waiting requests for a connection from the pool.
String	getName() Get the pool name to be used in this client.
int	getRecycleTimeout() Tune when a connection should be recycled in milliseconds.
PoolOptions	setCleanerInterval(int cleanerInterval) Tune how often in milliseconds should the connection pool cleaner execute.
PoolOptions	setMaxSize(int maxSize) Tune the maximum size of the connection pool.
PoolOptions	setMaxWaiting(int maxWaiting) Tune the maximum waiting requests for a connection from the pool.
PoolOptions	setName(String name) Set a user defined pool name (for metrics reporting).
PoolOptions	setRecycleTimeout(int recycleTimeout) Tune when a connection should be recycled in milliseconds.
JsonObject	toJson() Converts this object to JSON notation.

Methods inherited from class java.lang.Object

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

Constructor Detail

PoolOptions

public PoolOptions()

PoolOptions

public PoolOptions(PoolOptions other)

PoolOptions

public PoolOptions(JsonObject json)

Method Detail

setName

public PoolOptions setName(String name)

Set a user defined pool name (for metrics reporting).

Parameters:

name - the user desired pool name.

Returns:

fluent self

getName

public String getName()

Get the pool name to be used in this client. The default name is a random UUID.

Returns:

pool name.

getCleanerInterval

public int getCleanerInterval()

Tune how often in milliseconds should the connection pool cleaner execute.

Returns:

the cleaning internal

setCleanerInterval

public PoolOptions setCleanerInterval(int cleanerInterval)

Tune how often in milliseconds should the connection pool cleaner execute. For each connection in the pool, connections marked as invalid will be forcibly closed. A connection is marked invalid if it enters a exception or fatal state.

Parameters:

cleanerInterval - the interval in milliseconds (-1 for never)

Returns:

fluent self.

getMaxSize

public int getMaxSize()

Tune the maximum size of the connection pool.

Returns:

the size.

setMaxSize

public PoolOptions setMaxSize(int maxSize)

Tune the maximum size of the connection pool. When working with cluster or sentinel this value should be atleast the total number of cluster member (or number of sentinels + 1)

Parameters:

maxSize - the max pool size.

Returns:

fluent self.

getMaxWaiting

public int getMaxWaiting()

Tune the maximum waiting requests for a connection from the pool.

Returns:

the maximum waiting requests.

setMaxWaiting

public PoolOptions setMaxWaiting(int maxWaiting)

Tune the maximum waiting requests for a connection from the pool.

Parameters:

maxWaiting - max waiting requests

Returns:

fluent self.

getRecycleTimeout

public int getRecycleTimeout()

Tune when a connection should be recycled in milliseconds.

Returns:

the timeout for recycling.

setRecycleTimeout

public PoolOptions setRecycleTimeout(int recycleTimeout)

Tune when a connection should be recycled in milliseconds.

Parameters:

recycleTimeout - the timeout for recycling.

Returns:

fluent self.

toJson

public JsonObject toJson()

Converts this object to JSON notation.

Returns:

JSON