Modifier and Type	Class and Description
pack-priv static class	AllocationStrategies.SizeBasedAllocationStrategy
pack-priv static class	AllocationStrategies.UnboundedAllocationStrategy

Access	Constructor and Description
pack-priv	AllocationStrategies()

AllocationStrategies	back to summary
pack-priv AllocationStrategies()

pack-priv final Class AllocationStrategies.SizeBasedAllocationStrategy

Class Inheritance

extends Object
implements AllocationStrategy

java.lang.Object
reactor.pool.AllocationStrategies.SizeBasedAllocationStrategy

All Implemented Interfaces

reactor.pool.AllocationStrategy

Field Summary

Modifier and Type	Field and Description
pack-priv final int	max
pack-priv final int	min
pack-priv volatile int	permits
pack-priv static final AtomicIntegerFieldUpdater<AllocationStrategies.SizeBasedAllocationStrategy>	PERMITS
pack-priv final int	warmupParallelism

Constructor Summary

Access	Constructor and Description
pack-priv	SizeBasedAllocationStrategy(int min, int max)
pack-priv	SizeBasedAllocationStrategy(int min, int max, int warmupParallelism)

Method Summary

Modifier and Type	Method and Description
public int	estimatePermitCount() Implements reactor.pool.AllocationStrategy.estimatePermitCount. Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated.
public int	getPermits(int the desired number of new resources desired) Implements reactor.pool.AllocationStrategy.getPermits. Try to get the permission to allocate a `desired` positive number of new resources.
public int	permitGranted() Implements reactor.pool.AllocationStrategy.permitGranted.
public int	permitMaximum() Implements reactor.pool.AllocationStrategy.permitMaximum.
public int	permitMinimum() Implements reactor.pool.AllocationStrategy.permitMinimum. Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or `0` for scale-to-zero.
public void	returnPermits(int returned) Implements reactor.pool.AllocationStrategy.returnPermits. Update the strategy to indicate that N resources were discarded from the `Pool`, potentially leaving space for N new ones to be allocated.
public int	warmupParallelism() Overrides default reactor.pool.AllocationStrategy.warmupParallelism. Return the concurrency level used when the allocator is subscribed to during the warmup phase, if any.

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

Field Detail

max	back to summary
pack-priv final int max

min	back to summary
pack-priv final int min

permits	back to summary
pack-priv volatile int permits

PERMITS	back to summary
pack-priv static final AtomicIntegerFieldUpdater<AllocationStrategies.SizeBasedAllocationStrategy> PERMITS

warmupParallelism	back to summary
pack-priv final int warmupParallelism

Constructor Detail

SizeBasedAllocationStrategy	back to summary
pack-priv SizeBasedAllocationStrategy(int min, int max)

SizeBasedAllocationStrategy	back to summary
pack-priv SizeBasedAllocationStrategy(int min, int max, int warmupParallelism)

Method Detail

estimatePermitCount back to summary

estimatePermitCount	back to summary
public int estimatePermitCount() Implements reactor.pool.AllocationStrategy.estimatePermitCount. Doc from reactor.pool.AllocationStrategy.estimatePermitCount. Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated. Should be paired with `getPermits(int)` for an atomic permission. Returns:int an ESTIMATED count of how many more resources can currently be allocated Annotations @Override

public int estimatePermitCount()

Implements reactor.pool.AllocationStrategy.estimatePermitCount.

Doc from reactor.pool.AllocationStrategy.estimatePermitCount.

Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated. Should be paired with getPermits(int) for an atomic permission.

Returns:int

an ESTIMATED count of how many more resources can currently be allocated

Annotations

@Override

getPermits back to summary

getPermits	back to summary
public int getPermits(int desired) Implements reactor.pool.AllocationStrategy.getPermits. Doc from reactor.pool.AllocationStrategy.getPermits. Try to get the permission to allocate a `desired` positive number of new resources. Returns the permissible number of resources which MUST be created (otherwise the internal live counter of the strategy might be off). This permissible number might be zero, and it can also be a greater number than `desired`, which could for example denote a minimum warmed-up size for the pool to maintain (see below). Once a resource is discarded from the pool, it must update the strategy using `returnPermits(int)` (which can happen in batches or with value 1). For the warming up case, the typical pattern would be to call this method with a `desired` of zero. Parameters desired:int the desired number of new resources Returns:int the actual number of new resources that MUST be created, can be 0 and can be more than `desired` Annotations @Override

public int getPermits(int desired)

Implements reactor.pool.AllocationStrategy.getPermits.

Doc from reactor.pool.AllocationStrategy.getPermits.

Try to get the permission to allocate a desired positive number of new resources. Returns the permissible number of resources which MUST be created (otherwise the internal live counter of the strategy might be off). This permissible number might be zero, and it can also be a greater number than desired, which could for example denote a minimum warmed-up size for the pool to maintain (see below). Once a resource is discarded from the pool, it must update the strategy using returnPermits(int) (which can happen in batches or with value 1).

For the warming up case, the typical pattern would be to call this method with a desired of zero.

Parameters

desired:int: the desired number of new resources

Returns:int

the actual number of new resources that MUST be created, can be 0 and can be more than desired

Annotations

@Override

permitGranted back to summary

permitGranted	back to summary
public int permitGranted() Implements reactor.pool.AllocationStrategy.permitGranted. Returns:int Doc from reactor.pool.AllocationStrategy.permitGranted. a best estimate of the number of permits currently granted, between 0 and `Integer#MAX_VALUE` Annotations @Override

public int permitGranted()

Implements reactor.pool.AllocationStrategy.permitGranted.

Returns:int

Doc from reactor.pool.AllocationStrategy.permitGranted.

a best estimate of the number of permits currently granted, between 0 and Integer#MAX_VALUE

Annotations

@Override

permitMaximum back to summary

permitMaximum	back to summary
public int permitMaximum() Implements reactor.pool.AllocationStrategy.permitMaximum. Returns:int Doc from reactor.pool.AllocationStrategy.permitMaximum. the maximum number of permits this strategy can grant in total, or `Integer#MAX_VALUE` for unbounded Annotations @Override

public int permitMaximum()

Implements reactor.pool.AllocationStrategy.permitMaximum.

Returns:int

Doc from reactor.pool.AllocationStrategy.permitMaximum.

the maximum number of permits this strategy can grant in total, or Integer#MAX_VALUE for unbounded

Annotations

@Override

permitMinimum back to summary

permitMinimum	back to summary
public int permitMinimum() Implements reactor.pool.AllocationStrategy.permitMinimum. Doc from reactor.pool.AllocationStrategy.permitMinimum. Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or `0` for scale-to-zero. Returns:int the minimum number of permits this strategy tries to maintain, or `0` Annotations @Override

public int permitMinimum()

Implements reactor.pool.AllocationStrategy.permitMinimum.

Doc from reactor.pool.AllocationStrategy.permitMinimum.

Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or 0 for scale-to-zero.

Returns:int

the minimum number of permits this strategy tries to maintain, or 0

Annotations

@Override

returnPermits back to summary

returnPermits	back to summary
public void returnPermits(int returned) Implements reactor.pool.AllocationStrategy.returnPermits. Doc from reactor.pool.AllocationStrategy.returnPermits. Update the strategy to indicate that N resources were discarded from the `Pool`, potentially leaving space for N new ones to be allocated. Users MUST ensure that this method isn't called with a value greater than the number of held permits it has. Some strategy MIGHT throw an `IllegalArgumentException` if it can be determined the number of returned permits is not consistent with the strategy's limits and delivered permits. Annotations @Override

public void returnPermits(int returned)

Implements reactor.pool.AllocationStrategy.returnPermits.

Doc from reactor.pool.AllocationStrategy.returnPermits.

Update the strategy to indicate that N resources were discarded from the Pool, potentially leaving space for N new ones to be allocated. Users MUST ensure that this method isn't called with a value greater than the number of held permits it has.

Some strategy MIGHT throw an IllegalArgumentException if it can be determined the number of returned permits is not consistent with the strategy's limits and delivered permits.

Annotations

@Override

warmupParallelism back to summary

warmupParallelism	back to summary
public int warmupParallelism() Overrides default reactor.pool.AllocationStrategy.warmupParallelism. Doc from reactor.pool.AllocationStrategy.warmupParallelism. Return the concurrency level used when the allocator is subscribed to during the warmup phase, if any. The number of resources created concurrently will not exceed the value returned by `warmupParallelism()`. If the concurrency level is set to 1, pre-allocation of resources will be performed sequentially by subscribing to the allocator one at a time. The process waits for a resource to be created before subscribing again to the allocator. This sequence continues until all pre-allocated resources have been successfully created. Defaults to 1 Returns:int The concurrency level used when the allocator is subscribed to during the warmup phase, must be positive, `1` by default Annotations @Override

public int warmupParallelism()

Overrides default reactor.pool.AllocationStrategy.warmupParallelism.

Doc from reactor.pool.AllocationStrategy.warmupParallelism.

Return the concurrency level used when the allocator is subscribed to during the warmup phase, if any.

The number of resources created concurrently will not exceed the value returned by warmupParallelism(). If the concurrency level is set to 1, pre-allocation of resources will be performed sequentially by subscribing to the allocator one at a time. The process waits for a resource to be created before subscribing again to the allocator. This sequence continues until all pre-allocated resources have been successfully created.

Defaults to 1

Returns:int

The concurrency level used when the allocator is subscribed to during the warmup phase, must be positive, 1 by default

Annotations

@Override

reactor.pool back to summary

pack-priv final Class AllocationStrategies.UnboundedAllocationStrategy

Class Inheritance

extends AtomicInteger
implements AllocationStrategy

java.lang.Object
java.lang.Number
java.util.concurrent.atomic.AtomicInteger
reactor.pool.AllocationStrategies.UnboundedAllocationStrategy

All Implemented Interfaces

reactor.pool.AllocationStrategy

Constructor Summary

Access	Constructor and Description
pack-priv	UnboundedAllocationStrategy()

Method Summary

Modifier and Type	Method and Description
public int	estimatePermitCount() Implements reactor.pool.AllocationStrategy.estimatePermitCount. Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated.
public int	getPermits(int the desired number of new resources desired) Implements reactor.pool.AllocationStrategy.getPermits. Try to get the permission to allocate a `desired` positive number of new resources.
public int	permitGranted() Implements reactor.pool.AllocationStrategy.permitGranted.
public int	permitMaximum() Implements reactor.pool.AllocationStrategy.permitMaximum.
public int	permitMinimum() Implements reactor.pool.AllocationStrategy.permitMinimum. Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or `0` for scale-to-zero.
public void	returnPermits(int returned) Implements reactor.pool.AllocationStrategy.returnPermits. Update the strategy to indicate that N resources were discarded from the `Pool`, potentially leaving space for N new ones to be allocated.

Constructor Detail

UnboundedAllocationStrategy	back to summary
pack-priv UnboundedAllocationStrategy()

Method Detail

estimatePermitCount back to summary

estimatePermitCount	back to summary
public int estimatePermitCount() Implements reactor.pool.AllocationStrategy.estimatePermitCount. Doc from reactor.pool.AllocationStrategy.estimatePermitCount. Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated. Should be paired with `getPermits(int)` for an atomic permission. Returns:int an ESTIMATED count of how many more resources can currently be allocated Annotations @Override

public int estimatePermitCount()

Implements reactor.pool.AllocationStrategy.estimatePermitCount.

Doc from reactor.pool.AllocationStrategy.estimatePermitCount.

Best-effort peek at the state of the strategy which indicates roughly how many more resources can currently be allocated. Should be paired with getPermits(int) for an atomic permission.

Returns:int

an ESTIMATED count of how many more resources can currently be allocated

Annotations

@Override

getPermits back to summary

getPermits	back to summary
public int getPermits(int desired) Implements reactor.pool.AllocationStrategy.getPermits. Doc from reactor.pool.AllocationStrategy.getPermits. Try to get the permission to allocate a `desired` positive number of new resources. Returns the permissible number of resources which MUST be created (otherwise the internal live counter of the strategy might be off). This permissible number might be zero, and it can also be a greater number than `desired`, which could for example denote a minimum warmed-up size for the pool to maintain (see below). Once a resource is discarded from the pool, it must update the strategy using `returnPermits(int)` (which can happen in batches or with value 1). For the warming up case, the typical pattern would be to call this method with a `desired` of zero. Parameters desired:int the desired number of new resources Returns:int the actual number of new resources that MUST be created, can be 0 and can be more than `desired` Annotations @Override

public int getPermits(int desired)

Implements reactor.pool.AllocationStrategy.getPermits.

Doc from reactor.pool.AllocationStrategy.getPermits.

For the warming up case, the typical pattern would be to call this method with a desired of zero.

Parameters

desired:int: the desired number of new resources

Returns:int

the actual number of new resources that MUST be created, can be 0 and can be more than desired

Annotations

@Override

permitGranted back to summary

permitGranted	back to summary
public int permitGranted() Implements reactor.pool.AllocationStrategy.permitGranted. Returns:int Doc from reactor.pool.AllocationStrategy.permitGranted. a best estimate of the number of permits currently granted, between 0 and `Integer#MAX_VALUE` Annotations @Override

public int permitGranted()

Implements reactor.pool.AllocationStrategy.permitGranted.

Returns:int

Doc from reactor.pool.AllocationStrategy.permitGranted.

a best estimate of the number of permits currently granted, between 0 and Integer#MAX_VALUE

Annotations

@Override

permitMaximum back to summary

permitMaximum	back to summary
public int permitMaximum() Implements reactor.pool.AllocationStrategy.permitMaximum. Returns:int Doc from reactor.pool.AllocationStrategy.permitMaximum. the maximum number of permits this strategy can grant in total, or `Integer#MAX_VALUE` for unbounded Annotations @Override

public int permitMaximum()

Implements reactor.pool.AllocationStrategy.permitMaximum.

Returns:int

Doc from reactor.pool.AllocationStrategy.permitMaximum.

the maximum number of permits this strategy can grant in total, or Integer#MAX_VALUE for unbounded

Annotations

@Override

permitMinimum back to summary

permitMinimum	back to summary
public int permitMinimum() Implements reactor.pool.AllocationStrategy.permitMinimum. Doc from reactor.pool.AllocationStrategy.permitMinimum. Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or `0` for scale-to-zero. Returns:int the minimum number of permits this strategy tries to maintain, or `0` Annotations @Override

public int permitMinimum()

Implements reactor.pool.AllocationStrategy.permitMinimum.

Doc from reactor.pool.AllocationStrategy.permitMinimum.

Return the minimum number of permits this strategy tries to maintain granted (reflecting a minimal size for the pool), or 0 for scale-to-zero.

Returns:int

the minimum number of permits this strategy tries to maintain, or 0

Annotations

@Override

returnPermits back to summary

returnPermits	back to summary
public void returnPermits(int returned) Implements reactor.pool.AllocationStrategy.returnPermits. Doc from reactor.pool.AllocationStrategy.returnPermits. Update the strategy to indicate that N resources were discarded from the `Pool`, potentially leaving space for N new ones to be allocated. Users MUST ensure that this method isn't called with a value greater than the number of held permits it has. Some strategy MIGHT throw an `IllegalArgumentException` if it can be determined the number of returned permits is not consistent with the strategy's limits and delivered permits. Annotations @Override

public void returnPermits(int returned)

Implements reactor.pool.AllocationStrategy.returnPermits.

Doc from reactor.pool.AllocationStrategy.returnPermits.

Some strategy MIGHT throw an IllegalArgumentException if it can be determined the number of returned permits is not consistent with the strategy's limits and delivered permits.

Annotations

@Override

pack-priv final Class AllocationStrategies

Nested and Inner Type Summary

Constructor Summary

Method Summary

Constructor Detail

pack-priv final Class AllocationStrategies.SizeBasedAllocationStrategy

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv final Class AllocationStrategies.UnboundedAllocationStrategy

Constructor Summary

Method Summary

Constructor Detail

Method Detail