org.rvpf.processor

Class BatchControl

Object

BatchControl

public final class BatchControl
extends Object

Batch control.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTUAL_MEMORY_LOW_PROPERTY The minimum percentage of the JVM actual memory that should be used by a full batch.
static String	BATCH_INITIAL_PROPERTY The initial number of notices to accept before processing them.
static String	BATCH_MAXIMUM_PROPERTY The maximum number of notices to accept before processing them.
static int	DEFAULT_ACTUAL_MEMORY_LOW Default value for '"memory.actual.use.low"'.
static int	DEFAULT_BATCH_INITIAL Default value for '"batch.limit.initial"'.
static int	DEFAULT_BATCH_MAXIMUM Default value for '"batch.limit.maximum"'.
static int	DEFAULT_TOTAL_MEMORY_HIGH Default value for '"memory.total.use.high"'.
static int	DEFAULT_TOTAL_MEMORY_LOW Default value for '"memory.total.use.low"'.
static int	DEFAULT_TOTAL_MEMORY_MAXIMUM Default value for '"memory.total.use.maximum"'.
static String	RECEIVED_TRACES Received values trace subdirectory.
static String	SENT_TRACES Sent values trace subdirectory.
static String	TOTAL_MEMORY_HIGH_PROPERTY The maximum percentage of the JVM total memory that should be used be a batch.
static String	TOTAL_MEMORY_LOW_PROPERTY The minimum percentage of the JVM total memory that should be used by a full batch.
static String	TOTAL_MEMORY_MAXIMUM_PROPERTY The maximum percentage of the JVM total memory that can be used by a batch.

Constructor Summary

Constructors

Constructor and Description
BatchControl()

Method Summary

Modifier and Type	Method and Description
BatchImpl	newBatch() Returns a new batch instance.
boolean	setUp(Metadata metadata, Optional<CutoffControl> cutoffControl, CacheManager cacheManager, KeyedGroups configProperties) Sets up this batch factory.

Methods inherited from class Object

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

Field Detail

ACTUAL_MEMORY_LOW_PROPERTY

public static final String ACTUAL_MEMORY_LOW_PROPERTY

The minimum percentage of the JVM actual memory that should be used by a full batch. When underused, the next batch will be allowed 2 times more notices, up to '"batch.limit.maximum"'.

See Also:

Constant Field Values

BATCH_INITIAL_PROPERTY

public static final String BATCH_INITIAL_PROPERTY

The initial number of notices to accept before processing them.

See Also:

Constant Field Values

BATCH_MAXIMUM_PROPERTY

public static final String BATCH_MAXIMUM_PROPERTY

The maximum number of notices to accept before processing them.

See Also:

Constant Field Values

DEFAULT_ACTUAL_MEMORY_LOW

public static final int DEFAULT_ACTUAL_MEMORY_LOW

Default value for '"memory.actual.use.low"'.

See Also:

Constant Field Values

DEFAULT_BATCH_INITIAL

public static final int DEFAULT_BATCH_INITIAL

Default value for '"batch.limit.initial"'.

See Also:

Constant Field Values

DEFAULT_BATCH_MAXIMUM

public static final int DEFAULT_BATCH_MAXIMUM

Default value for '"batch.limit.maximum"'.

See Also:

Constant Field Values

DEFAULT_TOTAL_MEMORY_HIGH

public static final int DEFAULT_TOTAL_MEMORY_HIGH

Default value for '"memory.total.use.high"'.

See Also:

Constant Field Values

DEFAULT_TOTAL_MEMORY_LOW

public static final int DEFAULT_TOTAL_MEMORY_LOW

Default value for '"memory.total.use.low"'.

See Also:

Constant Field Values

DEFAULT_TOTAL_MEMORY_MAXIMUM

public static final int DEFAULT_TOTAL_MEMORY_MAXIMUM

Default value for '"memory.total.use.maximum"'.

See Also:

Constant Field Values

RECEIVED_TRACES

public static final String RECEIVED_TRACES

Received values trace subdirectory.

See Also:

Constant Field Values

SENT_TRACES

public static final String SENT_TRACES

Sent values trace subdirectory.

See Also:

Constant Field Values

TOTAL_MEMORY_HIGH_PROPERTY

public static final String TOTAL_MEMORY_HIGH_PROPERTY

The maximum percentage of the JVM total memory that should be used be a batch. When exceeded, the next batch will be allowed 2 times less notices.

See Also:

Constant Field Values

TOTAL_MEMORY_LOW_PROPERTY

public static final String TOTAL_MEMORY_LOW_PROPERTY

The minimum percentage of the JVM total memory that should be used by a full batch. When underused, the next batch will be allowed 2 times more notices, up to '"batch.limit.maximum"'.

See Also:

Constant Field Values

TOTAL_MEMORY_MAXIMUM_PROPERTY

public static final String TOTAL_MEMORY_MAXIMUM_PROPERTY

The maximum percentage of the JVM total memory that can be used by a batch. When exceeded, the batch will be cancelled and the next one will be allowed 10 times less notices (but at least 1). If the cancelled batch only had one notice in it, that notice will be dropped, since its processing requires too much resources.

See Also:

Constant Field Values

Constructor Detail

BatchControl

public BatchControl()

Method Detail

newBatch

@Nonnull
 @CheckReturnValue
public BatchImpl newBatch()

Returns a new batch instance.

Returns:

The new batch instance.

setUp

@CheckReturnValue
public boolean setUp(@Nonnull
                                        Metadata metadata,
                                        @Nonnull
                                        Optional<CutoffControl> cutoffControl,
                                        @Nonnull
                                        CacheManager cacheManager,
                                        @Nonnull
                                        KeyedGroups configProperties)

Sets up this batch factory.

Parameters:

metadata - The metadata.

cutoffControl - The optional cutoff control object.

cacheManager - The cache manager.

configProperties - The config properties.

Returns:

True on success.