Module ch.qos.logback.core

Package ch.qos.logback.core.util

Class BatchedFixedIntervalInvocationGate

java.lang.Object

ch.qos.logback.core.util.BatchedFixedIntervalInvocationGate

All Implemented Interfaces:

InvocationGate

public class BatchedFixedIntervalInvocationGate
extends Object
implements InvocationGate

An InvocationGate that allows a fixed number of successive callers to proceed, then enforces a lull of a fixed Duration.

Callers on a hot path use isTooSoon(long) to decide whether to skip a costly operation. Up to N invocations may receive false (proceed) in succession. After the N-th success, the gate enters a lull of increment milliseconds during which all callers receive true (skip). When the lull ends, another batch of N is available.

This extends the idea of FixedIntervalInvocationGate (at most one success per interval) to batches of size N. Token accounting and the lull deadline use atomics so concurrent callers share one batch.

Since:

1.6.3

Author:

Ceki Gülcü

See Also:

InvocationGate, FixedIntervalInvocationGate

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_BATCH_SIZE	Default batch size: number of successive allowed passages before a lull.
static Duration	DEFAULT_INCREMENT	Default lull duration after a batch is exhausted (same as FixedIntervalInvocationGate.DEFAULT_INCREMENT).

Fields inherited from interface ch.qos.logback.core.util.InvocationGate

TIME_UNAVAILABLE

Constructor Summary

Constructors

Constructor	Description
BatchedFixedIntervalInvocationGate()	Creates a gate with DEFAULT_BATCH_SIZE and DEFAULT_INCREMENT.
BatchedFixedIntervalInvocationGate(int batchSize)	Creates a gate with the given batch size and DEFAULT_INCREMENT.
BatchedFixedIntervalInvocationGate(int batchSize, Duration anIncrement)	Creates a gate that allows batchSize successive passages, then lulls for anIncrement.

Method Summary

Modifier and Type	Method	Description
boolean	isTooSoon(long currentTime)	Returns true if the caller should skip further work; false if this call is allowed to proceed.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BATCH_SIZE

public static final int DEFAULT_BATCH_SIZE

Default batch size: number of successive allowed passages before a lull.

See Also:

Constant Field Values

DEFAULT_INCREMENT

public static final Duration DEFAULT_INCREMENT

Default lull duration after a batch is exhausted (same as FixedIntervalInvocationGate.DEFAULT_INCREMENT).

Constructor Detail

BatchedFixedIntervalInvocationGate

public BatchedFixedIntervalInvocationGate()

Creates a gate with DEFAULT_BATCH_SIZE and DEFAULT_INCREMENT.

BatchedFixedIntervalInvocationGate

public BatchedFixedIntervalInvocationGate(int batchSize)

Creates a gate with the given batch size and DEFAULT_INCREMENT.

Parameters:

batchSize - number of successive allowed invocations per batch; must be at least 1

BatchedFixedIntervalInvocationGate

public BatchedFixedIntervalInvocationGate(int batchSize,
                                          Duration anIncrement)

Creates a gate that allows batchSize successive passages, then lulls for anIncrement.

Parameters:

batchSize - number of successive allowed invocations per batch; must be at least 1

anIncrement - lull duration after a batch is exhausted; must not be null

Method Detail

isTooSoon

public boolean isTooSoon(long currentTime)

Returns true if the caller should skip further work; false if this call is allowed to proceed.

If currentTime is InvocationGate.TIME_UNAVAILABLE (-1), returns false so work can still run when the clock is unavailable.

During a lull (currentTime before the next open time), returns true. Otherwise tries to consume one batch token. The first batchSize successful consumptions return false. The caller that takes the last token starts a lull of increment and re-arms the batch for after the lull.

Specified by:

isTooSoon in interface InvocationGate

Parameters:

currentTime - current time in milliseconds, or InvocationGate.TIME_UNAVAILABLE if unknown

Returns:

true if further work should be skipped; false if the caller may proceed