Package com.linkedin.alpini.netty4.pool

Class EspressoFixedChannelPool

java.lang.Object

com.linkedin.alpini.netty4.pool.EspressoSimpleChannelPool

com.linkedin.alpini.netty4.pool.EspressoFixedChannelPool

All Implemented Interfaces:

ChannelPoolWithStats, io.netty.channel.pool.ChannelPool, java.io.Closeable, java.lang.AutoCloseable

Direct Known Subclasses:

FixedChannelPoolImpl

public class EspressoFixedChannelPool
extends EspressoSimpleChannelPool
implements ChannelPoolWithStats

Forked from Netty's FixedChannelPool {ChannelPool} implementation that takes another {ChannelPool} implementation and enforce a maximum number of concurrent connections.

Constructor Summary

Constructors

Constructor	Description
EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.pool.ChannelPoolHandler handler, int maxConnections)	Creates a new instance using the ChannelHealthChecker.ACTIVE.
EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.pool.ChannelPoolHandler handler, int maxConnections, int maxPendingAcquires)	Creates a new instance using the ChannelHealthChecker.ACTIVE.
EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.pool.ChannelPoolHandler handler, io.netty.channel.pool.ChannelHealthChecker healthCheck, io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action, long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires)	Creates a new instance.
EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.pool.ChannelPoolHandler handler, io.netty.channel.pool.ChannelHealthChecker healthCheck, io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action, long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires, boolean releaseHealthCheck)	Creates a new instance.
EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap, io.netty.channel.pool.ChannelPoolHandler handler, io.netty.channel.pool.ChannelHealthChecker healthCheck, io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action, long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires, boolean releaseHealthCheck, boolean lastRecentUsed)	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
io.netty.util.concurrent.Future<io.netty.channel.Channel>	acquire(io.netty.util.concurrent.Promise<io.netty.channel.Channel> promise)
int	acquiredChannelCount()	Returns the number of acquired channels that this pool thinks it has.
void	close()
io.netty.util.concurrent.Future<java.lang.Void>	closeAsync()	Closes the pool in an async manner.
int	getAcquiredChannelCount()
int	getMaxConnections()
int	getMaxPendingAcquires()
int	getPendingAcquireCount()
void	incrementAcquiredChannelCount()
boolean	isClosed()
boolean	isPoolClosed()
java.lang.String	name()
io.netty.util.concurrent.Future<java.lang.Void>	release(io.netty.channel.Channel channel, io.netty.util.concurrent.Promise<java.lang.Void> promise)

Methods inherited from class com.linkedin.alpini.netty4.pool.EspressoSimpleChannelPool

acquire, bootstrap, connectChannel, getAvailableChannels, handler, healthChecker, offerChannel, pollChannel, release, releaseHealthCheck

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty.channel.pool.ChannelPool

acquire, release

Constructor Detail

EspressoFixedChannelPool

public EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.pool.ChannelPoolHandler handler,
                                int maxConnections)

Creates a new instance using the ChannelHealthChecker.ACTIVE.

Parameters:

bootstrap - the Bootstrap that is used for connections

handler - the ChannelPoolHandler that will be notified for the different pool actions

maxConnections - the number of maximal active connections, once this is reached new tries to acquire a Channel will be delayed until a connection is returned to the pool again.

EspressoFixedChannelPool

public EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.pool.ChannelPoolHandler handler,
                                int maxConnections,
                                int maxPendingAcquires)

Creates a new instance using the ChannelHealthChecker.ACTIVE.

Parameters:

bootstrap - the Bootstrap that is used for connections

handler - the ChannelPoolHandler that will be notified for the different pool actions

maxConnections - the number of maximal active connections, once this is reached new tries to acquire a Channel will be delayed until a connection is returned to the pool again.

maxPendingAcquires - the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

EspressoFixedChannelPool

public EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.pool.ChannelPoolHandler handler,
                                io.netty.channel.pool.ChannelHealthChecker healthCheck,
                                io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action,
                                long acquireTimeoutMillis,
                                int maxConnections,
                                int maxPendingAcquires)

Creates a new instance.

Parameters:

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}

action - the FixedChannelPool.AcquireTimeoutAction to use or null if non should be used. In this case {@param acquireTimeoutMillis} must be -1.

acquireTimeoutMillis - the time (in milliseconds) after which an pending acquire must complete or the FixedChannelPool.AcquireTimeoutAction takes place.

maxConnections - the number of maximal active connections, once this is reached new tries to acquire a Channel will be delayed until a connection is returned to the pool again.

maxPendingAcquires - the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

EspressoFixedChannelPool

public EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.pool.ChannelPoolHandler handler,
                                io.netty.channel.pool.ChannelHealthChecker healthCheck,
                                io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action,
                                long acquireTimeoutMillis,
                                int maxConnections,
                                int maxPendingAcquires,
                                boolean releaseHealthCheck)

Creates a new instance.

Parameters:

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}

action - the FixedChannelPool.AcquireTimeoutAction to use or null if non should be used. In this case acquireTimeoutMillis must be -1.

acquireTimeoutMillis - the time (in milliseconds) after which an pending acquire must complete or the FixedChannelPool.AcquireTimeoutAction takes place.

maxConnections - the number of maximal active connections, once this is reached new tries to acquire a Channel will be delayed until a connection is returned to the pool again.

maxPendingAcquires - the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

releaseHealthCheck - will check channel health before offering back if this parameter set to true.

EspressoFixedChannelPool

public EspressoFixedChannelPool(io.netty.bootstrap.Bootstrap bootstrap,
                                io.netty.channel.pool.ChannelPoolHandler handler,
                                io.netty.channel.pool.ChannelHealthChecker healthCheck,
                                io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction action,
                                long acquireTimeoutMillis,
                                int maxConnections,
                                int maxPendingAcquires,
                                boolean releaseHealthCheck,
                                boolean lastRecentUsed)

Creates a new instance.

Parameters:

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}

action - the FixedChannelPool.AcquireTimeoutAction to use or null if non should be used. In this case acquireTimeoutMillis must be -1.

acquireTimeoutMillis - the time (in milliseconds) after which an pending acquire must complete or the FixedChannelPool.AcquireTimeoutAction takes place.

maxConnections - the number of maximal active connections, once this is reached new tries to acquire a Channel will be delayed until a connection is returned to the pool again.

maxPendingAcquires - the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

releaseHealthCheck - will check channel health before offering back if this parameter set to true.

lastRecentUsed - true Channel selection will be LIFO, if false FIFO.

Method Detail

isPoolClosed

public boolean isPoolClosed()

name

public java.lang.String name()

Specified by:

name in interface ChannelPoolWithStats

acquiredChannelCount

public int acquiredChannelCount()

Returns the number of acquired channels that this pool thinks it has.

incrementAcquiredChannelCount

public void incrementAcquiredChannelCount()

acquire

public io.netty.util.concurrent.Future<io.netty.channel.Channel> acquire(io.netty.util.concurrent.Promise<io.netty.channel.Channel> promise)

Specified by:

acquire in interface io.netty.channel.pool.ChannelPool

Overrides:

acquire in class EspressoSimpleChannelPool

release

public io.netty.util.concurrent.Future<java.lang.Void> release(io.netty.channel.Channel channel,
                                                               io.netty.util.concurrent.Promise<java.lang.Void> promise)

Specified by:

release in interface io.netty.channel.pool.ChannelPool

Overrides:

release in class EspressoSimpleChannelPool

getMaxConnections

public int getMaxConnections()

Specified by:

getMaxConnections in interface ChannelPoolWithStats

getMaxPendingAcquires

public int getMaxPendingAcquires()

Specified by:

getMaxPendingAcquires in interface ChannelPoolWithStats

getAcquiredChannelCount

public int getAcquiredChannelCount()

Specified by:

getAcquiredChannelCount in interface ChannelPoolWithStats

getPendingAcquireCount

public int getPendingAcquireCount()

Specified by:

getPendingAcquireCount in interface ChannelPoolWithStats

isClosed

public boolean isClosed()

Specified by:

isClosed in interface ChannelPoolWithStats

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface io.netty.channel.pool.ChannelPool

Specified by:

close in interface java.io.Closeable

Overrides:

close in class EspressoSimpleChannelPool

closeAsync

public io.netty.util.concurrent.Future<java.lang.Void> closeAsync()

Closes the pool in an async manner.

Returns:

Future which represents completion of the close task