BeeConnectionPool (beecp 4.1.3 API)

所有已知实现类:

FastConnectionPool
```
public interface BeeConnectionPool
```
A Container maintains some borrowable connections for being reused.

版本:

1.0

作者:

Chris Liao

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`clear(boolean forceCloseUsing)` Closes all connections and removes them from pool.
`void`	`clear(boolean forceCloseUsing, BeeDataSourceConfig config)` Closes all connections and removes them from pool,then re-initialize pool with new configuration.
`void`	`close()` Closes all connections in pool and shutdown all work threads in pool,then pool state change to closed from working, disable all operation on pool.
`Connection`	`getConnection()` Attempts to get a connection from pool.
`int`	`getConnectionCreatingCount()` Get connection count in creating
`int`	`getConnectionCreatingTimeoutCount()` Get connection count in creating timeout
`BeeConnectionPoolMonitorVo`	`getPoolMonitorVo()` Gets monitor object of pool runtime info.
`XAConnection`	`getXAConnection()` Attempts to get a XAConnection from pool.
`void`	`init(BeeDataSourceConfig config)` Pool initializes,if success,pool state become to be ready for working,then borrowers can get connections from it.
`Thread[]`	`interruptConnectionCreating(boolean onlyInterruptTimeout)` interrupt threads creating connections
`boolean`	`isClosed()` Query pool state whether is closed.
`void`	`setPrintRuntimeLog(boolean indicator)` Changes switch of log print.

- 方法详细资料
  - init
```
void init(BeeDataSourceConfig config)
   throws SQLException
```
    Pool initializes,if success,pool state become to be ready for working,then borrowers can get connections from it.
    
    参数:
    
    config - is a configuration object,some items of it are used in initialization
    
    抛出:
    
    SQLException - when initializes failed
  - getConnection
```
Connection getConnection()
                  throws SQLException
```
    Attempts to get a connection from pool.
    
    返回:
    
    a borrowed connection
    
    抛出:
    
    SQLException - when pool creates a connection failed
    
    ConnectionGetTimeoutException - when borrower wait time out in pool
    
    ConnectionGetInterruptedException - if interrupted while waiting in pool
  - getXAConnection
```
XAConnection getXAConnection()
                      throws SQLException
```
    Attempts to get a XAConnection from pool.
    
    返回:
    
    a borrowed XAConnection
    
    抛出:
    
    SQLException - when pool creates a xa connection failed
    
    ConnectionGetTimeoutException - when borrower wait time out in pool
    
    ConnectionGetInterruptedException - if interrupted while waiting in pool
  - close
```
void close()
```
    Closes all connections in pool and shutdown all work threads in pool,then pool state change to closed from working, disable all operation on pool.
  - isClosed
```
boolean isClosed()
```
    Query pool state whether is closed.
    
    返回:
    
    true that pool is closed
  - setPrintRuntimeLog
```
void setPrintRuntimeLog(boolean indicator)
```
    Changes switch of log print.
    
    参数:
    
    indicator - is true that prints logs of pool work,false that disable print
  - getPoolMonitorVo
```
BeeConnectionPoolMonitorVo getPoolMonitorVo()
```
    Gets monitor object of pool runtime info.
    
    返回:
    
    monitor object of pool
  - getConnectionCreatingCount
```
int getConnectionCreatingCount()
```
    Get connection count in creating
    
    返回:
    
    a nanoseconds time;if not exists a creating thread,then return 0
  - getConnectionCreatingTimeoutCount
```
int getConnectionCreatingTimeoutCount()
```
    Get connection count in creating timeout
    
    返回:
    
    true that creation is timeout
  - interruptConnectionCreating
```
Thread[] interruptConnectionCreating(boolean onlyInterruptTimeout)
```
    interrupt threads creating connections
    
    参数:
    
    onlyInterruptTimeout - is true,attempt to interrupt creation timeout threads
    
    返回:
    
    interrupted threads,if no threads,then return null
  - clear
```
void clear(boolean forceCloseUsing)
    throws SQLException
```
    Closes all connections and removes them from pool.
    
    参数:
    
    forceCloseUsing - is an indicator that close borrowed connections immediately,or that close them when them return to pool
    
    抛出:
    
    SQLException - when pool closed or in cleaning
  - clear
```
void clear(boolean forceCloseUsing,
           BeeDataSourceConfig config)
    throws SQLException
```
    Closes all connections and removes them from pool,then re-initialize pool with new configuration.
    
    参数:
    
    forceCloseUsing - is an indicator that close borrowed connections immediately,or that close them when them return to pool
    
    config - is a new configuration object
    
    抛出:
    
    BeeDataSourceConfigException - when check failed on this new configuration
    
    SQLException - when pool closed or in cleaning
    
    SQLException - when pool reinitialize failed

接口 BeeConnectionPool

方法概要

方法详细资料

init

getConnection

getXAConnection

close

isClosed

setPrintRuntimeLog

getPoolMonitorVo

getConnectionCreatingCount

getConnectionCreatingTimeoutCount

interruptConnectionCreating

clear

clear