Package io.netty.channel.pool
Class SimpleChannelPool
java.lang.Object
io.netty.channel.pool.SimpleChannelPool
- All Implemented Interfaces:
ChannelPool
,Closeable
,AutoCloseable
- Direct Known Subclasses:
FixedChannelPool
Simple
ChannelPool
implementation which will create new Channel
s if someone tries to acquire
a Channel
but none is in the pool atm. No limit on the maximal concurrent Channel
s is enforced.
This implementation uses LIFO order for Channel
s in the ChannelPool
.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final Bootstrap
private final ChannelPoolHandler
private final ChannelHealthChecker
private final boolean
private static final AttributeKey
<SimpleChannelPool> private final boolean
-
Constructor Summary
ConstructorsConstructorDescriptionSimpleChannelPool
(Bootstrap bootstrap, ChannelPoolHandler handler) Creates a new instance using theChannelHealthChecker.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. -
Method Summary
Modifier and TypeMethodDescriptionacquire()
Acquire aChannel
from thisChannelPool
.Acquire aChannel
from thisChannelPool
.acquireHealthyFromPoolOrNew
(Promise<Channel> promise) Tries to retrieve healthy channel from the pool if any or creates a new channel otherwise.protected Bootstrap
Returns theBootstrap
this pool will use to open new connections.void
close()
private void
closeAndFail
(Channel channel, Throwable cause, Promise<?> promise) Closes the pool in an async manner.private void
closeChannel
(Channel channel) protected ChannelFuture
Bootstrap a newChannel
.private void
doHealthCheck
(Channel channel, Promise<Channel> promise) private void
doHealthCheckOnRelease
(Channel channel, Promise<Void> promise) private void
doReleaseChannel
(Channel channel, Promise<Void> promise) protected ChannelPoolHandler
handler()
Returns theChannelPoolHandler
that will be notified for the different pool actions.protected ChannelHealthChecker
Returns theChannelHealthChecker
that will be used to check if aChannel
is healthy.private void
notifyConnect
(ChannelFuture future, Promise<Channel> promise) private void
protected boolean
offerChannel
(Channel channel) Offer aChannel
back to the internal storage.protected Channel
Poll aChannel
out of the internal storage to reuse it.Release aChannel
back to thisChannelPool
.Release aChannel
back to thisChannelPool
.private void
releaseAndOffer
(Channel channel, Promise<Void> promise) private void
Adds the channel back to the pool only if the channel is healthy.protected boolean
Indicates whether this pool will check the health of channels before offering them back into the pool.
-
Field Details
-
POOL_KEY
-
deque
-
handler
-
healthCheck
-
bootstrap
-
releaseHealthCheck
private final boolean releaseHealthCheck -
lastRecentUsed
private final boolean lastRecentUsed
-
-
Constructor Details
-
SimpleChannelPool
Creates a new instance using theChannelHealthChecker.ACTIVE
.- Parameters:
bootstrap
- theBootstrap
that is used for connectionshandler
- theChannelPoolHandler
that will be notified for the different pool actions
-
SimpleChannelPool
public SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck) Creates a new instance.- Parameters:
bootstrap
- theBootstrap
that is used for connectionshandler
- theChannelPoolHandler
that will be notified for the different pool actionshealthCheck
- theChannelHealthChecker
that will be used to check if aChannel
is still healthy when obtain from theChannelPool
-
SimpleChannelPool
public SimpleChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, boolean releaseHealthCheck) Creates a new instance.- Parameters:
bootstrap
- theBootstrap
that is used for connectionshandler
- theChannelPoolHandler
that will be notified for the different pool actionshealthCheck
- theChannelHealthChecker
that will be used to check if aChannel
is still healthy when obtain from theChannelPool
releaseHealthCheck
- will check channel health before offering back if this parameter set totrue
; 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.- Parameters:
bootstrap
- theBootstrap
that is used for connectionshandler
- theChannelPoolHandler
that will be notified for the different pool actionshealthCheck
- theChannelHealthChecker
that will be used to check if aChannel
is still healthy when obtain from theChannelPool
releaseHealthCheck
- will check channel health before offering back if this parameter set totrue
; otherwise, channel health is only checked at acquisition timelastRecentUsed
-true
Channel
selection will be LIFO, iffalse
FIFO.
-
-
Method Details
-
bootstrap
Returns theBootstrap
this pool will use to open new connections.- Returns:
- the
Bootstrap
this pool will use to open new connections
-
handler
Returns theChannelPoolHandler
that will be notified for the different pool actions.- Returns:
- the
ChannelPoolHandler
that will be notified for the different pool actions
-
healthChecker
Returns theChannelHealthChecker
that will be used to check if aChannel
is healthy.- Returns:
- the
ChannelHealthChecker
that will be used to check if aChannel
is healthy
-
releaseHealthCheck
protected boolean releaseHealthCheck()Indicates whether this pool will check the health of channels before offering them back into the pool.- Returns:
true
if this pool will check the health of channels before offering them back into the pool, orfalse
if channel health is only checked at acquisition time
-
acquire
Description copied from interface:ChannelPool
Acquire aChannel
from thisChannelPool
. The returnedFuture
is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if theChannel
is explicitly closed..- Specified by:
acquire
in interfaceChannelPool
-
acquire
Description copied from interface:ChannelPool
Acquire aChannel
from thisChannelPool
. The givenPromise
is notified once the acquire is successful and failed otherwise. Its important that an acquired is always released to the pool again, even if theChannel
is explicitly closed..- Specified by:
acquire
in interfaceChannelPool
-
acquireHealthyFromPoolOrNew
Tries to retrieve healthy channel from the pool if any or creates a new channel otherwise.- Parameters:
promise
- the promise to provide acquire result.- Returns:
- future for acquiring a channel.
-
notifyConnect
-
doHealthCheck
-
notifyHealthCheck
-
connectChannel
Bootstrap a newChannel
. The default implementation usesBootstrap.connect()
, sub-classes may override this.The
Bootstrap
that is passed in here is cloned viaBootstrap.clone()
, so it is safe to modify. -
release
Description copied from interface:ChannelPool
Release aChannel
back to thisChannelPool
. The returnedFuture
is notified once the release is successful and failed otherwise. When failed theChannel
will automatically closed.- Specified by:
release
in interfaceChannelPool
-
release
Description copied from interface:ChannelPool
Release aChannel
back to thisChannelPool
. The givenPromise
is notified once the release is successful and failed otherwise. When failed theChannel
will automatically closed.- Specified by:
release
in interfaceChannelPool
-
doReleaseChannel
-
doHealthCheckOnRelease
- Throws:
Exception
-
releaseAndOfferIfHealthy
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
- the channel to put back to the poolpromise
- offer operation promise.future
- the future that contains information fif channel is healthy or not.- Throws:
Exception
- in case when failed to notify handler about release operation.
-
releaseAndOffer
- Throws:
Exception
-
closeChannel
- Throws:
Exception
-
closeAndFail
-
pollChannel
Poll aChannel
out of the internal storage to reuse it. This will returnnull
if noChannel
is ready to be reused. Sub-classes may overridepollChannel()
andofferChannel(Channel)
. Be aware that implementations of these methods needs to be thread-safe! -
offerChannel
Offer aChannel
back to the internal storage. This will returntrue
if theChannel
could be added,false
otherwise. Sub-classes may overridepollChannel()
andofferChannel(Channel)
. Be aware that implementations of these methods needs to be thread-safe! -
close
public void close()- Specified by:
close
in interfaceAutoCloseable
- Specified by:
close
in interfaceChannelPool
- Specified by:
close
in interfaceCloseable
-
closeAsync
Closes the pool in an async manner.- Returns:
- Future which represents completion of the close task
-