SimpleChannelPool (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.channel.pool.SimpleChannelPool

所有已实现的接口:

ChannelPool, java.io.Closeable, java.lang.AutoCloseable

直接已知子类:

FixedChannelPool
```
public class SimpleChannelPool
extends java.lang.Object
implements ChannelPool
```
Simple ChannelPool implementation which will create new Channels if someone tries to acquire a Channel but none is in the pool atm. No limit on the maximal concurrent Channels is enforced. This implementation uses LIFO order for Channels in the ChannelPool.

构造器概要

构造器
构造器和说明
`SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler)` Creates a new instance using the `ChannelHealthChecker.ACTIVE`.
`SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck)` Creates a new instance.
`SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck)` Creates a new instance.
`SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck, boolean lastRecentUsed)` Creates a new instance.

方法概要

All Methods Instance Methods Concrete Methods
限定符和类型	方法和说明
`Future<Channel>`	`acquire()` Acquire a `Channel` from this `ChannelPool`.
`Future<Channel>`	`acquire(Promise<Channel> promise)` Acquire a `Channel` from this `ChannelPool`.
`protected Bootstrap`	`bootstrap()` Returns the `Bootstrap` this pool will use to open new connections.
`void`	`close()`
`Future<java.lang.Void>`	`closeAsync()` Closes the pool in an async manner.
`protected ChannelFuture`	`connectChannel(Bootstrap bs)` Bootstrap a new `Channel`.
`protected ChannelPoolHandler`	`handler()` Returns the `ChannelPoolHandler` that will be notified for the different pool actions.
`protected ChannelHealthChecker`	`healthChecker()` Returns the `ChannelHealthChecker` that will be used to check if a `Channel` is healthy.
`protected boolean`	`offerChannel(Channel channel)` Offer a `Channel` back to the internal storage.
`protected Channel`	`pollChannel()` Poll a `Channel` out of the internal storage to reuse it.
`Future<java.lang.Void>`	`release(Channel channel)` Release a `Channel` back to this `ChannelPool`.
`Future<java.lang.Void>`	`release(Channel channel, Promise<java.lang.Void> promise)` Release a `Channel` back to this `ChannelPool`.
`protected boolean`	`releaseHealthCheck()` Indicates whether this pool will check the health of channels before offering them back into the pool.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SimpleChannelPool
```
public SimpleChannelPool(Bootstrap bootstrap,
                         ChannelPoolHandler handler)
```
    Creates a new instance using the ChannelHealthChecker.ACTIVE.
    
    参数:
    
    bootstrap - the Bootstrap that is used for connections
    
    handler - the ChannelPoolHandler that will be notified for the different pool actions
  - SimpleChannelPool
```
public SimpleChannelPool(Bootstrap bootstrap,
                         ChannelPoolHandler handler,
                         ChannelHealthChecker healthCheck)
```
    Creates a new instance.
    
    参数:
    
    bootstrap - the Bootstrap that is used for connections
    
    handler - the ChannelPoolHandler that will be notified for the different pool actions
    
    healthCheck - the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool
  - SimpleChannelPool
```
public SimpleChannelPool(Bootstrap bootstrap,
                         ChannelPoolHandler handler,
                         ChannelHealthChecker healthCheck,
                         boolean releaseHealthCheck)
```
    Creates a new instance.
    
    参数:
    
    bootstrap - the Bootstrap that is used for connections
    
    handler - the ChannelPoolHandler that will be notified for the different pool actions
    
    healthCheck - the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool
    
    releaseHealthCheck - will check channel health before offering back if this parameter set to true; otherwise, channel health is only checked at acquisition time
  - SimpleChannelPool
```
public SimpleChannelPool(Bootstrap bootstrap,
                         ChannelPoolHandler handler,
                         ChannelHealthChecker healthCheck,
                         boolean releaseHealthCheck,
                         boolean lastRecentUsed)
```
    Creates a new instance.
    
    参数:
    
    bootstrap - the Bootstrap that is used for connections
    
    handler - the ChannelPoolHandler that will be notified for the different pool actions
    
    healthCheck - the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool
    
    releaseHealthCheck - will check channel health before offering back if this parameter set to true; otherwise, channel health is only checked at acquisition time
    
    lastRecentUsed - true Channel selection will be LIFO, if false FIFO.
- 方法详细资料
  - bootstrap
```
protected Bootstrap bootstrap()
```
    Returns the Bootstrap this pool will use to open new connections.
    
    返回:
    
    the Bootstrap this pool will use to open new connections
  - handler
```
protected ChannelPoolHandler handler()
```
    Returns the ChannelPoolHandler that will be notified for the different pool actions.
    
    返回:
    
    the ChannelPoolHandler that will be notified for the different pool actions
  - healthChecker
```
protected ChannelHealthChecker healthChecker()
```
    Returns the ChannelHealthChecker that will be used to check if a Channel is healthy.
    
    返回:
    
    the ChannelHealthChecker that will be used to check if a Channel is healthy
  - releaseHealthCheck
```
protected boolean releaseHealthCheck()
```
    Indicates whether this pool will check the health of channels before offering them back into the pool.
    
    返回:
    
    true if this pool will check the health of channels before offering them back into the pool, or false if channel health is only checked at acquisition time
  - acquire
```
public final Future<Channel> acquire()
```
    从接口复制的说明: ChannelPool
    
    Acquire a Channel from this ChannelPool. The returned Future is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if the Channel is explicitly closed..
    
    指定者:
    
    acquire 在接口中 ChannelPool
  - acquire
```
public Future<Channel> acquire(Promise<Channel> promise)
```
    从接口复制的说明: ChannelPool
    
    Acquire a Channel from this ChannelPool. The given Promise is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if the Channel is explicitly closed..
    
    指定者:
    
    acquire 在接口中 ChannelPool
  - connectChannel
```
protected ChannelFuture connectChannel(Bootstrap bs)
```
    Bootstrap a new Channel. The default implementation uses Bootstrap.connect(), sub-classes may override this.
    The Bootstrap that is passed in here is cloned via Bootstrap.clone(), so it is safe to modify.
  - release
```
public final Future<java.lang.Void> release(Channel channel)
```
    从接口复制的说明: ChannelPool
    
    Release a Channel back to this ChannelPool. The returned Future is notified once the release is successful and failed otherwise. When failed the Channel will automatically closed.
    
    指定者:
    
    release 在接口中 ChannelPool
  - release
```
public Future<java.lang.Void> release(Channel channel,
                                      Promise<java.lang.Void> promise)
```
    从接口复制的说明: ChannelPool
    
    Release a Channel back to this ChannelPool. The given Promise is notified once the release is successful and failed otherwise. When failed the Channel will automatically closed.
    
    指定者:
    
    release 在接口中 ChannelPool
  - pollChannel
```
protected Channel pollChannel()
```
    Poll a Channel out of the internal storage to reuse it. This will return null if no Channel is ready to be reused. Sub-classes may override pollChannel() and offerChannel(Channel). Be aware that implementations of these methods needs to be thread-safe!
  - offerChannel
```
protected boolean offerChannel(Channel channel)
```
    Offer a Channel back to the internal storage. This will return true if the Channel could be added, false otherwise. Sub-classes may override pollChannel() and offerChannel(Channel). Be aware that implementations of these methods needs to be thread-safe!
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 ChannelPool
    
    指定者:
    
    close 在接口中 java.io.Closeable
    
    指定者:
    
    close 在接口中 java.lang.AutoCloseable
  - closeAsync
```
public Future<java.lang.Void> closeAsync()
```
    Closes the pool in an async manner.
    
    返回:
    
    Future which represents completion of the close task

类 SimpleChannelPool

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SimpleChannelPool

SimpleChannelPool

SimpleChannelPool

SimpleChannelPool

方法详细资料

bootstrap

handler

healthChecker

releaseHealthCheck

acquire

acquire

connectChannel

release

release

pollChannel

offerChannel

close

closeAsync