Top Description Inners Fields Constructors Methods

io.netty.channel.pool

public Class FixedChannelPool

Class Inheritance

extends SimpleChannelPool

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

Static Imports

io.netty.util.internal.ObjectUtil.checkPositive

ChannelPool implementation that takes another ChannelPool implementation and enforce a maximum number of concurrent connections.

Nested and Inner Type Summary

Modifier and Type	Class and Description
private class	FixedChannelPool.AcquireListener
private class	FixedChannelPool.AcquireTask
public static enum	FixedChannelPool.AcquireTimeoutAction
private static class	FixedChannelPool.AcquireTimeoutException
private abstract class	FixedChannelPool.TimeoutTask

Field Summary

Modifier and Type	Field and Description
private final AtomicInteger	acquiredChannelCount
private final long	acquireTimeoutNanos
private boolean	closed
private final EventExecutor	executor
private final int	maxConnections
private final int	maxPendingAcquires
private int	pendingAcquireCount
private final Queue<FixedChannelPool.AcquireTask>	pendingAcquireQueue
private final Runnable	timeoutTask

Constructor Summary

Access	Constructor and Description
public	FixedChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler, int 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. maxConnections) Creates a new instance using the `ChannelHealthChecker#ACTIVE`.
public	FixedChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, ChannelPoolHandler the `ChannelPoolHandler` that will be notified for the different pool actions handler, int 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. maxConnections, int the maximum number of pending acquires. Once this is exceed acquire tries will be failed. maxPendingAcquires) Creates a new instance using the `ChannelHealthChecker#ACTIVE`.
public	FixedChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, 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, FixedChannelPool.AcquireTimeoutAction the `AcquireTimeoutAction` to use or `null` if non should be used. In this case {@param acquireTimeoutMillis} must be `-1`. action, final long the time (in milliseconds) after which an pending acquire must complete or the `AcquireTimeoutAction` takes place. acquireTimeoutMillis, int 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. maxConnections, int the maximum number of pending acquires. Once this is exceed acquire tries will be failed. maxPendingAcquires) Creates a new instance.
public	FixedChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, 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, FixedChannelPool.AcquireTimeoutAction the `AcquireTimeoutAction` to use or `null` if non should be used. In this case {@param acquireTimeoutMillis} must be `-1`. action, final long the time (in milliseconds) after which an pending acquire must complete or the `AcquireTimeoutAction` takes place. acquireTimeoutMillis, int 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. maxConnections, int the maximum number of pending acquires. Once this is exceed acquire tries will be failed. maxPendingAcquires, final boolean will check channel health before offering back if this parameter set to `true`. releaseHealthCheck) Creates a new instance.
public	FixedChannelPool(Bootstrap the `Bootstrap` that is used for connections bootstrap, 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, FixedChannelPool.AcquireTimeoutAction the `AcquireTimeoutAction` to use or `null` if non should be used. In this case {@param acquireTimeoutMillis} must be `-1`. action, final long the time (in milliseconds) after which an pending acquire must complete or the `AcquireTimeoutAction` takes place. acquireTimeoutMillis, int 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. maxConnections, int the maximum number of pending acquires. Once this is exceed acquire tries will be failed. maxPendingAcquires, boolean will check channel health before offering back if this parameter set to `true`. 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 Future<Channel>	acquire(final Promise<Channel> promise) Overrides io.netty.channel.pool.SimpleChannelPool.acquire. Implements io.netty.channel.pool.ChannelPool.acquire. Acquire a `Channel` from this `ChannelPool`.
private void	acquire0(final Promise<Channel> promise)
public int	acquiredChannelCount() Returns the number of acquired channels that this pool thinks it has.
public void	close() Overrides io.netty.channel.pool.SimpleChannelPool.close. Implements io.netty.channel.pool.ChannelPool.close. Closes this stream and releases any system resources associated with it.
private Future<Void>	close0()
public Future<Void>	Returns: Future which represents completion of the close task closeAsync() Overrides io.netty.channel.pool.SimpleChannelPool.closeAsync. Closes the pool in an async manner.
private void	decrementAndRunTaskQueue()
public Future<Void>	release(final Channel channel, final Promise<Void> promise) Overrides io.netty.channel.pool.SimpleChannelPool.release. Implements io.netty.channel.pool.ChannelPool.release. Release a `Channel` back to this `ChannelPool`.
private void	runTaskQueue()
private void	tooManyOutstanding(Promise<?> promise)

Inherited from io.netty.channel.pool.SimpleChannelPool:: acquire bootstrap connectChannel handler healthChecker offerChannel pollChannel release releaseHealthCheck

Field Detail

acquiredChannelCount	back to summary
private final AtomicInteger acquiredChannelCount

acquireTimeoutNanos	back to summary
private final long acquireTimeoutNanos

closed	back to summary
private boolean closed

executor	back to summary
private final EventExecutor executor

maxConnections	back to summary
private final int maxConnections

maxPendingAcquires	back to summary
private final int maxPendingAcquires

pendingAcquireCount	back to summary
private int pendingAcquireCount

pendingAcquireQueue	back to summary
private final Queue<FixedChannelPool.AcquireTask> pendingAcquireQueue

timeoutTask	back to summary
private final Runnable timeoutTask

Constructor Detail

FixedChannelPool back to summary

public FixedChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, int maxConnections)

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
maxConnections:int: 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.

FixedChannelPool back to summary

public FixedChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, int maxConnections, int maxPendingAcquires)

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
maxConnections:int: 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:int: the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

FixedChannelPool back to summary

public FixedChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, FixedChannelPool.AcquireTimeoutAction action, final long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires)

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
action:FixedChannelPool.AcquireTimeoutAction: the AcquireTimeoutAction to use or null if non should be used. In this case {@param acquireTimeoutMillis} must be -1.
acquireTimeoutMillis:long: the time (in milliseconds) after which an pending acquire must complete or the AcquireTimeoutAction takes place.
maxConnections:int: 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:int: the maximum number of pending acquires. Once this is exceed acquire tries will be failed.

FixedChannelPool back to summary

public FixedChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, FixedChannelPool.AcquireTimeoutAction action, final long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires, final 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
action:FixedChannelPool.AcquireTimeoutAction: the AcquireTimeoutAction to use or null if non should be used. In this case {@param acquireTimeoutMillis} must be -1.
acquireTimeoutMillis:long: the time (in milliseconds) after which an pending acquire must complete or the AcquireTimeoutAction takes place.
maxConnections:int: 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:int: the maximum number of pending acquires. Once this is exceed acquire tries will be failed.
releaseHealthCheck:boolean: will check channel health before offering back if this parameter set to true.

FixedChannelPool back to summary

public FixedChannelPool(Bootstrap bootstrap, ChannelPoolHandler handler, ChannelHealthChecker healthCheck, FixedChannelPool.AcquireTimeoutAction action, final long acquireTimeoutMillis, int maxConnections, int maxPendingAcquires, 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
action:FixedChannelPool.AcquireTimeoutAction: the AcquireTimeoutAction to use or null if non should be used. In this case {@param acquireTimeoutMillis} must be -1.
acquireTimeoutMillis:long: the time (in milliseconds) after which an pending acquire must complete or the AcquireTimeoutAction takes place.
maxConnections:int: 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:int: the maximum number of pending acquires. Once this is exceed acquire tries will be failed.
releaseHealthCheck:boolean: will check channel health before offering back if this parameter set to true.
lastRecentUsed:boolean: true Channel selection will be LIFO, if false FIFO.

Method Detail

acquire back to summary

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

Overrides io.netty.channel.pool.SimpleChannelPool.acquire.

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

acquire0	back to summary
private void acquire0(final Promise<Channel> promise)

acquiredChannelCount	back to summary
public int acquiredChannelCount() Returns the number of acquired channels that this pool thinks it has.

close back to summary

public void close()

Overrides io.netty.channel.pool.SimpleChannelPool.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

close0	back to summary
private Future<Void> close0()

closeAsync

back to summary

public Future<Void> closeAsync()

Overrides io.netty.channel.pool.SimpleChannelPool.closeAsync.

Closes the pool in an async manner.

Returns:Future<Void>

Future which represents completion of the close task

Annotations

@Override

decrementAndRunTaskQueue	back to summary
private void decrementAndRunTaskQueue()

release back to summary

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

Overrides io.netty.channel.pool.SimpleChannelPool.release.

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

runTaskQueue	back to summary
private void runTaskQueue()

tooManyOutstanding	back to summary
private void tooManyOutstanding(Promise<?> promise)

io.netty.channel.pool back to summary

private Class FixedChannelPool.AcquireListener

Class Inheritance

extends Object
implements FutureListener<Channel>

java.lang.Object
io.netty.channel.pool.FixedChannelPool.AcquireListener

All Implemented Interfaces

io.netty.util.concurrent.FutureListener, io.netty.util.concurrent.GenericFutureListener, java.util.EventListener

Known Direct Subclasses

io.netty.channel.pool.FixedChannelPool.AcquireTask

Field Summary

Modifier and Type	Field and Description
protected boolean	acquired
private final Promise<Channel>	originalPromise

Constructor Summary

Access	Constructor and Description
pack-priv	AcquireListener(Promise<Channel> originalPromise)

Method Summary

Modifier and Type	Method and Description
public void	acquired()
public void	operationComplete(Future<Channel> the source `Future` which called this callback future) Implements io.netty.util.concurrent.GenericFutureListener.operationComplete. Invoked when the operation associated with the `Future` has been completed.

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

Field Detail

acquired	back to summary
protected boolean acquired

originalPromise	back to summary
private final Promise<Channel> originalPromise

Constructor Detail

AcquireListener	back to summary
pack-priv AcquireListener(Promise<Channel> originalPromise)

Method Detail

acquired	back to summary
public void acquired()

operationComplete back to summary

public void operationComplete(Future<Channel> future) throws Exception

Implements io.netty.util.concurrent.GenericFutureListener.operationComplete.

Doc from io.netty.util.concurrent.GenericFutureListener.operationComplete.

Invoked when the operation associated with the Future has been completed.

Parameters

future:Future<Channel>: the source Future which called this callback

Annotations

@Override

io.netty.channel.pool back to summary

private final Class FixedChannelPool.AcquireTask

Class Inheritance

extends AcquireListener

java.lang.Object
io.netty.channel.pool.FixedChannelPool.AcquireListener
io.netty.channel.pool.FixedChannelPool.AcquireTask

Field Summary

Modifier and Type	Field and Description
pack-priv final long	expireNanoTime
pack-priv final Promise<Channel>	promise
pack-priv ScheduledFuture<?>	timeoutFuture

Inherited from io.netty.channel.pool.FixedChannelPool.AcquireListener:: acquired

Constructor Summary

Access	Constructor and Description
pack-priv	AcquireTask(Promise<Channel> promise)

Method Summary

Inherited from io.netty.channel.pool.FixedChannelPool.AcquireListener:: acquired operationComplete

Field Detail

expireNanoTime	back to summary
pack-priv final long expireNanoTime

promise	back to summary
pack-priv final Promise<Channel> promise

timeoutFuture	back to summary
pack-priv ScheduledFuture<?> timeoutFuture

Constructor Detail

AcquireTask	back to summary
pack-priv AcquireTask(Promise<Channel> promise)

io.netty.channel.pool back to summary

public final Enum FixedChannelPool.AcquireTimeoutAction

Class Inheritance

extends Enum<FixedChannelPool.AcquireTimeoutAction>

java.lang.Object
java.lang.Enum
io.netty.channel.pool.FixedChannelPool.AcquireTimeoutAction

Field Summary

Modifier and Type	Field and Description
public static final FixedChannelPool.AcquireTimeoutAction	FAIL Fail the `Future` of the acquire call with a `TimeoutException`.
public static final FixedChannelPool.AcquireTimeoutAction	NEW Create a new connection when the timeout is detected.

Constructor Summary

Access	Constructor and Description
private	AcquireTimeoutAction()

Method Summary

Modifier and Type	Method and Description
public static FixedChannelPool.AcquireTimeoutAction	valueOf(String name)
public static FixedChannelPool.AcquireTimeoutAction[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

FAIL	back to summary
public static final FixedChannelPool.AcquireTimeoutAction FAIL Fail the `Future` of the acquire call with a `TimeoutException`.

NEW	back to summary
public static final FixedChannelPool.AcquireTimeoutAction NEW Create a new connection when the timeout is detected.

Constructor Detail

AcquireTimeoutAction	back to summary
private AcquireTimeoutAction()

Method Detail

valueOf	back to summary
public static FixedChannelPool.AcquireTimeoutAction valueOf(String name)

values	back to summary
public static FixedChannelPool.AcquireTimeoutAction[] values()

io.netty.channel.pool back to summary

private final Class FixedChannelPool.AcquireTimeoutException

Class Inheritance

extends TimeoutException

java.lang.Object
java.lang.Throwable
java.lang.Exception
java.util.concurrent.TimeoutException
io.netty.channel.pool.FixedChannelPool.AcquireTimeoutException

Constructor Summary

Access	Constructor and Description
private	AcquireTimeoutException()

Method Summary

Modifier and Type	Method and Description
public Throwable	fillInStackTrace() Overrides java.lang.Throwable.fillInStackTrace. Fills in the execution stack trace.

Constructor Detail

AcquireTimeoutException	back to summary
private AcquireTimeoutException()

Method Detail

fillInStackTrace back to summary

public Throwable fillInStackTrace()

Overrides java.lang.Throwable.fillInStackTrace.

Doc from java.lang.Throwable.fillInStackTrace.

Fills in the execution stack trace. This method records within this Throwable object information about the current state of the stack frames for the current thread.

If the stack trace of this Throwable is not writable, calling this method has no effect.

Returns:Throwable

a reference to this Throwable instance.

Annotations

@Override

io.netty.channel.pool back to summary

private abstract Class FixedChannelPool.TimeoutTask

Class Inheritance

extends Object
implements Runnable

java.lang.Object
io.netty.channel.pool.FixedChannelPool.TimeoutTask

All Implemented Interfaces

java.lang.Runnable

Constructor Summary

Access	Constructor and Description
private	TimeoutTask()

Method Summary

Modifier and Type	Method and Description
public abstract void	onTimeout(FixedChannelPool.AcquireTask task)
public final void	run() Implements java.lang.Runnable.run. Runs this operation.

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

Constructor Detail

TimeoutTask	back to summary
private TimeoutTask()

Method Detail

onTimeout	back to summary
public abstract void onTimeout(FixedChannelPool.AcquireTask task)

run

back to summary

public final void run()

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override