com.github.houbb.redis.client.api.pool.IRedisClientPoolConfig Maven / Gradle / Ivy
The newest version!
package com.github.houbb.redis.client.api.pool;
/**
* redis 客户端池化配置
* @author binbin.hou
* @since 0.0.3
*/
public interface IRedisClientPoolConfig {
/**
* 设置最大总数
* @param maxTotal 总数
* @return 总数
* @since 0.0.3
*/
IRedisClientPoolConfig maxTotal(final int maxTotal);
/**
* 获取最大总数
* @return 最大总数
* @since 0.0.3
*/
int maxTotal();
/**
* 资源池允许的最大空闲连接数
* @return 数量
* @since 0.0.3
*/
int maxIdle();
/**
* 设置资源池允许的最大空闲连接数
* @param maxIdle 连接数
* @return this
* @since 0.0.3
*/
IRedisClientPoolConfig maxIdle(int maxIdle);
/**
* 资源池允许的最小空闲连接数
* @return 连接数
* @since 0.0.3
*/
int minIdle();
/**
* 设置资源池允许的最小空闲连接数
* @param minIdle 连接数
* @return this
* @since 0.0.3
*/
IRedisClientPoolConfig minIdle(int minIdle);
/**
* 当资源池用尽后，调用者是否要等待。
* @return 是否
* @since 0.0.3
*/
boolean blockWhenExhausted();
/**
* 当资源池用尽后，调用者是否要等待。
* @param blockWhenExhausted 是否
* @return this
* @since 0.0.3
*/
IRedisClientPoolConfig blockWhenExhausted(boolean blockWhenExhausted);
/**
* 最大等待的毫秒数
* @return 时间
* @since 0.0.3
*/
int maxWaitMillis();
/**
* 最大等待的毫秒数
* @param maxWaitMillis 毫秒数
* @return 时间
* @since 0.0.3
*/
IRedisClientPoolConfig maxWaitMillis(int maxWaitMillis);
/**
* 向资源池借用连接时是否做连接有效性检测（ping）。检测到的无效连接将会被移除。
* @return 是否
* @since 0.0.3
*/
boolean testOnBorrow();
/**
* 向资源池借用连接时是否做连接有效性检测（ping）。检测到的无效连接将会被移除。
* @param testOnBorrow 是否
* @since 0.0.3
* @return this
*/
IRedisClientPoolConfig testOnBorrow(boolean testOnBorrow);
/**
* 向资源池归还连接时是否做连接有效性检测（ping）。检测到无效连接将会被移除。
* @return 是否
* @since 0.0.3
*/
boolean testOnReturn();
/**
* 向资源池归还连接时是否做连接有效性检测（ping）。检测到无效连接将会被移除。
* @param testOnReturn 是否
* @return this
* @since 0.0.3
*/
IRedisClientPoolConfig testOnReturn(boolean testOnReturn);
}