ThreadMgr::FinishBatch

Defined in: C4Threads.h

Waits for the completion of a batch.

Prototype

void FinishBatch(Batch *batch);

Parameters

batch The batch to wait on.

Description

The FinishBatch function blocks the calling thread and waits for all of the jobs belonging to the batch specified by the batch parameter to complete. If no jobs had been submitted in the batch since it was constructed or since the last call to FinishBatch for the same batch, then this function returns immediately.

After all of the jobs in the batch have completed, each job's finalization function is called, if it has one. Nonpersistent job objects in the batch are destroyed before the FinishBatch function returns.