com.mulesoft.mule.runtime.module.batch.internal.engine.buffer

Interface RecordBuffer

All Superinterfaces:

org.mule.runtime.api.meta.NamedObject

All Known Implementing Classes:

AbstractRecordBuffer, AbstractStreamingAggregatorQueueBuffer, AggregatorRecordBuffer, FixedAggregatorRecordBuffer, FixedAggregatorTransactionRecordBuffer, InMemoryRecordBuffer, LoadingQueueBuffer, SteppingQueueBuffer, StreamingAggregatorBuffer, StreamingAggregatorInputQueueBuffer, StreamingAggregatorOutputQueueBuffer, TransactionalQueueBuffer

public interface RecordBuffer
extends org.mule.runtime.api.meta.NamedObject

Buffer for holding records so that potentially slow operations can be performed in a bulk. Operations elegible for buffering could be queueing, persisting, executing a step aggregator, etc.

Since:

3.5.0

Method Summary

Modifier and Type	Method and Description
int	add(BatchJobInstanceAdapter jobInstance, BatchTransactionContextProvider ctxProvider, Record record) Invokes add(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter, com.mulesoft.mule.runtime.module.batch.engine.transaction.BatchTransactionContext, Record) using the BatchTransactionContext returned by the context provider
int	add(BatchJobInstanceAdapter jobInstance, BatchTransactionContext ctx, Record record) buffers the given Record for the given BatchJobInstanceAdapter
void	flush(BatchJobInstanceAdapter jobInstance) Flushes the buffered Records for the given BatchJobInstanceAdapter.
void	flushAndForget(BatchJobInstanceAdapter jobInstance) Atomically performs a flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).
void	forget(BatchJobInstanceAdapter jobInstance) Releases all tracking information for the given BatchJobInstanceAdapter
long	size(BatchJobInstanceAdapter jobInstance) Returns how many records are buffered for the given BatchJobInstanceAdapter

Methods inherited from interface org.mule.runtime.api.meta.NamedObject

getName

Method Detail

add

int add(BatchJobInstanceAdapter jobInstance,
        BatchTransactionContextProvider ctxProvider,
        Record record)

Invokes add(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter, com.mulesoft.mule.runtime.module.batch.engine.transaction.BatchTransactionContext, Record) using the BatchTransactionContext returned by the context provider

Parameters:

jobInstance - a BatchJobInstanceAdapter

ctxProvider - a BatchTransactionContextProvider

record - a Record

Returns:

how many records are still buffered for the given job instance

add

int add(BatchJobInstanceAdapter jobInstance,
        BatchTransactionContext ctx,
        Record record)

buffers the given Record for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter

record - a Record

Returns:

how many records are still buffered for the given job instance

flush

void flush(BatchJobInstanceAdapter jobInstance)

Flushes the buffered Records for the given BatchJobInstanceAdapter.

Use this method when you want to flush the info but you still expect more records from the same job instance to come. In this way, you flush the records but you avoid constantly recreating the internal tracking information.

This is a thread-safe operation.

Parameters:

jobInstance - the BatchJobInstanceAdapter which records you want flushed

flushAndForget

void flushAndForget(BatchJobInstanceAdapter jobInstance)

Atomically performs a flush(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter) followed by a forget(com.mulesoft.mule.runtime.module.batch.engine.BatchJobInstanceAdapter).

You MUST use this method when you know that the given jobInstance will no longer be executed in order to avoid a memory leak on its tracking information

This is NOT a thread-safe operation. You must be careful to not have several threads invoking this method at the same time for the same BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

forget

void forget(BatchJobInstanceAdapter jobInstance)

Releases all tracking information for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter which you no longer need to track

size

long size(BatchJobInstanceAdapter jobInstance)

Returns how many records are buffered for the given BatchJobInstanceAdapter

Parameters:

jobInstance - a BatchJobInstanceAdapter

Returns:

a long value