Batch
This class is designed to hold entities that are waiting within a process for the creation of a batch of entities via the waitedForBatch() suspending function. The main purpose of this class is to hold the entities that are waiting to be batched in a similar manner as a HoldQueue. The entities held within this queue are suspended until the batch is formed. The parameters of this class permit the specification of a default batch size and a default predicate that will be used to form the batch via the waitForBatch() suspending function; however, the user can supply their own batch size and predicate at the suspending function call site.
Notice that batches are formed from the same type (subclass) of BatchingEntity. Thus, this queue is limited to holding and participating in the forming of batches of the same type of entity.
Parameters
the element's parent model element
the default batch size for this queue
the default predicate to use when selecting elements for the batch. The default is an alwaysTrueFunction, such that every element in the queue satisfies the selection criterion.
the elements name
the queue discipline for the queue
the type of batching entity being held in the queue. A batching entity has additional functionality to hold the formed batches.
Constructors
Properties
The predicate used to form batches during a replication
The default batch size for the queue for each replication. This property cannot be changed during a replication.
The default initial predicate for all replications. The batching predicate will be set to this default at the beginning of each replication to ensure that each replication starts with the same conditions.