Netty/Transport 4.1.107.Final · io.netty.channel.pool.SimpleChannelPool

Modifier and Type	Class and Description
private static class	SimpleChannelPool.ChannelPoolFullException

Modifier and Type	Field and Description
private final Bootstrap	bootstrap
private final Deque<Channel>	deque
private final ChannelPoolHandler	handler
private final ChannelHealthChecker	healthCheck
private final boolean	lastRecentUsed
private static final AttributeKey<SimpleChannelPool>	POOL_KEY
private final boolean	releaseHealthCheck

Constructor Summary

Access	Constructor and Description
public	SimpleChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, final ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler) Creates a new instance using the `ChannelHealthChecker#ACTIVE`.
public	SimpleChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, final ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler, ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool` healthCheck) Creates a new instance.
public	SimpleChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, final ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler, ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool` healthCheck, boolean will check channel health before offering back if this parameter set to `true`; otherwise, channel health is only checked at acquisition time releaseHealthCheck) Creates a new instance.
public	SimpleChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, final ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler, ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool` healthCheck, boolean will check channel health before offering back if this parameter set to `true`; otherwise, channel health is only checked at acquisition time releaseHealthCheck, boolean `true` `Channel` selection will be LIFO, if `false` FIFO. lastRecentUsed) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
public final Future<Channel>	acquire() Implements io.netty.channel.pool.ChannelPool.acquire. Acquire a `Channel` from this `ChannelPool`.
public Future<Channel>	acquire(final Promise<Channel> promise) Implements io.netty.channel.pool.ChannelPool.acquire. Acquire a `Channel` from this `ChannelPool`.
private Future<Channel>	Returns: future for acquiring a channel. acquireHealthyFromPoolOrNew(final Promise<Channel> the promise to provide acquire result. promise) Tries to retrieve healthy channel from the pool if any or creates a new channel otherwise.
protected Bootstrap	Returns: the `Bootstrap` this pool will use to open new connections bootstrap() Returns the `Bootstrap` this pool will use to open new connections.
public void	close() Implements io.netty.channel.pool.ChannelPool.close. Closes this stream and releases any system resources associated with it.
private void	closeAndFail(Channel channel, Throwable cause, Promise<?> promise)
public Future<Void>	Returns: Future which represents completion of the close task closeAsync() Closes the pool in an async manner.
private void	closeChannel(Channel channel)
protected ChannelFuture	connectChannel(Bootstrap bs) Bootstrap a new `Channel`.
private void	doHealthCheck(final Channel channel, final Promise<Channel> promise)
private void	doHealthCheckOnRelease(final Channel channel, final Promise<Void> promise)
private void	doReleaseChannel(Channel channel, Promise<Void> promise)
protected ChannelPoolHandler	Returns: the `ChannelPoolHandler` that will be notified for the different pool actions handler() Returns the `ChannelPoolHandler` that will be notified for the different pool actions.
protected ChannelHealthChecker	Returns: the `ChannelHealthChecker` that will be used to check if a `Channel` is healthy healthChecker() Returns the `ChannelHealthChecker` that will be used to check if a `Channel` is healthy.
private void	notifyConnect(ChannelFuture future, Promise<Channel> promise)
private void	notifyHealthCheck(Future<Boolean> future, Channel channel, Promise<Channel> promise)
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.
public final Future<Void>	release(Channel channel) Implements io.netty.channel.pool.ChannelPool.release. Release a `Channel` back to this `ChannelPool`.
public Future<Void>	release(final Channel channel, final Promise<Void> promise) Implements io.netty.channel.pool.ChannelPool.release. Release a `Channel` back to this `ChannelPool`.
private void	releaseAndOffer(Channel channel, Promise<Void> promise)
private void	releaseAndOfferIfHealthy(Channel the channel to put back to the pool channel, Promise<Void> offer operation promise. promise, Future<Boolean> the future that contains information fif channel is healthy or not. future) Adds the channel back to the pool only if the channel is healthy.
protected boolean	Returns: `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 releaseHealthCheck() Indicates whether this pool will check the health of channels before offering them back into the pool.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

bootstrap	back to summary
private final Bootstrap bootstrap

deque	back to summary
private final Deque<Channel> deque

handler	back to summary
private final ChannelPoolHandler handler

healthCheck	back to summary
private final ChannelHealthChecker healthCheck

lastRecentUsed	back to summary
private final boolean lastRecentUsed

POOL_KEY	back to summary
private static final AttributeKey<SimpleChannelPool> POOL_KEY

releaseHealthCheck	back to summary
private final boolean releaseHealthCheck

Constructor Detail

SimpleChannelPool back to summary

SimpleChannelPool	back to summary
public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler) Creates a new instance using the `ChannelHealthChecker#ACTIVE`. Parameters bootstrap:Bootstrap the `Bootstrap` that is used for connections handler:ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions

public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler)

Creates a new instance using the ChannelHealthChecker#ACTIVE.

Parameters

bootstrap:Bootstrap: the Bootstrap that is used for connections
handler:ChannelPoolHandler: the ChannelPoolHandler that will be notified for the different pool actions

SimpleChannelPool back to summary

SimpleChannelPool	back to summary
public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck) Creates a new instance. Parameters bootstrap:Bootstrap the `Bootstrap` that is used for connections handler:ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions healthCheck:ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool`

public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck)

Creates a new instance.

Parameters

bootstrap:Bootstrap: the Bootstrap that is used for connections
handler:ChannelPoolHandler: the ChannelPoolHandler that will be notified for the different pool actions
healthCheck:ChannelHealthChecker: the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool

SimpleChannelPool back to summary

SimpleChannelPool	back to summary
public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck) Creates a new instance. Parameters bootstrap:Bootstrap the `Bootstrap` that is used for connections handler:ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions healthCheck:ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool` releaseHealthCheck:boolean will check channel health before offering back if this parameter set to `true`; otherwise, channel health is only checked at acquisition time

public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck)

Creates a new instance.

Parameters

bootstrap:Bootstrap: the Bootstrap that is used for connections
handler:ChannelPoolHandler: the ChannelPoolHandler that will be notified for the different pool actions
healthCheck:ChannelHealthChecker: the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool
releaseHealthCheck:boolean: will check channel health before offering back if this parameter set to true; otherwise, channel health is only checked at acquisition time

SimpleChannelPool back to summary

SimpleChannelPool	back to summary
public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck, boolean lastRecentUsed) Creates a new instance. Parameters bootstrap:Bootstrap the `Bootstrap` that is used for connections handler:ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions healthCheck:ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is still healthy when obtain from the `ChannelPool` releaseHealthCheck:boolean will check channel health before offering back if this parameter set to `true`; otherwise, channel health is only checked at acquisition time lastRecentUsed:boolean `true` `Channel` selection will be LIFO, if `false` FIFO.

public SimpleChannelPool(Bootstrap bootstrap, final ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck, boolean lastRecentUsed)

Creates a new instance.

Parameters

bootstrap:Bootstrap: the Bootstrap that is used for connections
handler:ChannelPoolHandler: the ChannelPoolHandler that will be notified for the different pool actions
healthCheck:ChannelHealthChecker: the ChannelHealthChecker that will be used to check if a Channel is still healthy when obtain from the ChannelPool
releaseHealthCheck:boolean: will check channel health before offering back if this parameter set to true; otherwise, channel health is only checked at acquisition time
lastRecentUsed:boolean: true Channel selection will be LIFO, if false FIFO.

Method Detail

acquire back to summary

acquire	back to summary
public final Future<Channel> acquire() Implements io.netty.channel.pool.ChannelPool.acquire. Doc from io.netty.channel.pool.ChannelPool.acquire. 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.. Annotations @Override

public final Future<Channel> acquire()

Implements io.netty.channel.pool.ChannelPool.acquire.

Doc from io.netty.channel.pool.ChannelPool.acquire.

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..

Annotations

@Override

acquire back to summary

acquire	back to summary
public Future<Channel> acquire(final Promise<Channel> promise) Implements io.netty.channel.pool.ChannelPool.acquire. Doc from io.netty.channel.pool.ChannelPool.acquire. 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.. Annotations @Override

public Future<Channel> acquire(final Promise<Channel> promise)

Implements io.netty.channel.pool.ChannelPool.acquire.

Doc from io.netty.channel.pool.ChannelPool.acquire.

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..

Annotations

@Override

acquireHealthyFromPoolOrNew	back to summary
private Future<Channel> acquireHealthyFromPoolOrNew(final Promise<Channel> promise) Tries to retrieve healthy channel from the pool if any or creates a new channel otherwise. Parameters promise:Promise<Channel> the promise to provide acquire result. Returns:Future<Channel> future for acquiring a channel.

acquireHealthyFromPoolOrNew

back to summary

private Future<Channel> acquireHealthyFromPoolOrNew(final Promise<Channel> promise)

Tries to retrieve healthy channel from the pool if any or creates a new channel otherwise.

Parameters

promise:Promise<Channel>: the promise to provide acquire result.

Returns:Future<Channel>

future for acquiring a channel.

bootstrap back to summary

bootstrap	back to summary
protected Bootstrap bootstrap() Returns the `Bootstrap` this pool will use to open new connections. Returns:Bootstrap the `Bootstrap` this pool will use to open new connections

protected Bootstrap bootstrap()

Returns the Bootstrap this pool will use to open new connections.

Returns:Bootstrap: the Bootstrap this pool will use to open new connections

close back to summary

close	back to summary
public void close() Implements io.netty.channel.pool.ChannelPool.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Implements io.netty.channel.pool.ChannelPool.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

closeAndFail	back to summary
private void closeAndFail(Channel channel, Throwable cause, Promise<?> promise)

closeAsync	back to summary
public Future<Void> closeAsync() Closes the pool in an async manner. Returns:Future<Void> Future which represents completion of the close task

closeAsync

back to summary

public Future<Void> closeAsync()

Closes the pool in an async manner.

Returns:Future<Void>: Future which represents completion of the close task

closeChannel	back to summary
private void closeChannel(Channel channel) throws Exception

connectChannel back to summary

connectChannel	back to summary
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.

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.

doHealthCheck	back to summary
private void doHealthCheck(final Channel channel, final Promise<Channel> promise)

doHealthCheckOnRelease	back to summary
private void doHealthCheckOnRelease(final Channel channel, final Promise<Void> promise) throws Exception

doReleaseChannel	back to summary
private void doReleaseChannel(Channel channel, Promise<Void> promise)

handler back to summary

handler	back to summary
protected ChannelPoolHandler handler() Returns the `ChannelPoolHandler` that will be notified for the different pool actions. Returns:ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions

protected ChannelPoolHandler handler()

Returns the ChannelPoolHandler that will be notified for the different pool actions.

Returns:ChannelPoolHandler: the ChannelPoolHandler that will be notified for the different pool actions

healthChecker back to summary

healthChecker	back to summary
protected ChannelHealthChecker healthChecker() Returns the `ChannelHealthChecker` that will be used to check if a `Channel` is healthy. Returns:ChannelHealthChecker the `ChannelHealthChecker` that will be used to check if a `Channel` is healthy

protected ChannelHealthChecker healthChecker()

Returns the ChannelHealthChecker that will be used to check if a Channel is healthy.

Returns:ChannelHealthChecker: the ChannelHealthChecker that will be used to check if a Channel is healthy

notifyConnect	back to summary
private void notifyConnect(ChannelFuture future, Promise<Channel> promise)

notifyHealthCheck	back to summary
private void notifyHealthCheck(Future<Boolean> future, Channel channel, Promise<Channel> promise)

offerChannel	back to summary
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!

pollChannel	back to summary
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!

release back to summary

release	back to summary
public final Future<Void> release(Channel channel) Implements io.netty.channel.pool.ChannelPool.release. Doc from io.netty.channel.pool.ChannelPool.release. 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. Annotations @Override

public final Future<Void> release(Channel channel)

Implements io.netty.channel.pool.ChannelPool.release.

Doc from io.netty.channel.pool.ChannelPool.release.

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.

Annotations

@Override

release back to summary

release	back to summary
public Future<Void> release(final Channel channel, final Promise<Void> promise) Implements io.netty.channel.pool.ChannelPool.release. Doc from io.netty.channel.pool.ChannelPool.release. 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. Annotations @Override

public Future<Void> release(final Channel channel, final Promise<Void> promise)

Implements io.netty.channel.pool.ChannelPool.release.

Doc from io.netty.channel.pool.ChannelPool.release.

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.

Annotations

@Override

releaseAndOffer	back to summary
private void releaseAndOffer(Channel channel, Promise<Void> promise) throws Exception

releaseAndOfferIfHealthy	back to summary
private void releaseAndOfferIfHealthy(Channel channel, Promise<Void> promise, Future<Boolean> future) Adds the channel back to the pool only if the channel is healthy. Parameters channel:Channel the channel to put back to the pool promise:Promise<Void> offer operation promise. future:Future<Boolean> the future that contains information fif channel is healthy or not. Exceptions Exception: in case when failed to notify handler about release operation.

releaseAndOfferIfHealthy

back to summary

private void releaseAndOfferIfHealthy(Channel channel, Promise<Void> promise, Future<Boolean> future)

Adds the channel back to the pool only if the channel is healthy.

Parameters

channel:Channel: the channel to put back to the pool
promise:Promise<Void>: offer operation promise.
future:Future<Boolean>: the future that contains information fif channel is healthy or not.

Exceptions

Exception:: in case when failed to notify handler about release operation.

releaseHealthCheck back to summary

releaseHealthCheck	back to summary
protected boolean releaseHealthCheck() Indicates whether this pool will check the health of channels before offering them back into the pool. Returns:boolean `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

protected boolean releaseHealthCheck()

Indicates whether this pool will check the health of channels before offering them back into the pool.

Returns:boolean: 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

public Class SimpleChannelPool

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class SimpleChannelPool.ChannelPoolFullException

Constructor Summary

Method Summary

Constructor Detail

Method Detail