AsyncAll

This BIF accepts an array of futures/closures/lambdas and executes them all in parallel.

It returns a BoxFuture that will contain an array of results once all futures are completed successfully.

This means that the futures will be executed in parallel and the results will be returned in the order that they were passed in. This also means that this operation is non-blocking and will return immediately until you call get() on the future.

Each future can be a BoxFuture or a CompletableFuture or a BoxLang Function that will be treated as a future.

 results = all( [f1, f2, f3] ).get()
 all( [f1, f2, f3] ).then( (values) => logResults( values ) );
 

Method Signature

AsyncAll(futures=[array], executor=[any])

Arguments

Argument	Type	Required	Description	Default
futures	array	true	An array of BoxFuture objects to process in parallel
executor	any	false	The executor to use for the BoxFuture object. By default, the BoxFuture object will use the default executor (ForkJoinPool.commonPool()). This can be the name of a named executor or a custom executor record.

Examples

Wait for all async operations to complete

Accepts an array of futures/closures/lambdas and executes them all in parallel.

f1 = asyncRun( () => sleep( 100 ) && return "one" );
f2 = asyncRun( () => sleep( 100 ) && return "two" );
f3 = asyncRun( () => sleep( 100 ) && return "three" );
results = all( [ f1, f2, f3 ] ).get();
writeOutput( results.len() );

Result: 3

Results are returned in the order they were passed

slow = asyncRun( () => sleep( 200 ) && return "slow" );
fast = asyncRun( () => sleep( 50 ) && return "fast" );
results = all( [ slow, fast ] ).get();
writeOutput( results[ 1 ] );

Result: slow

Using closures directly without pre-creating futures

results = all( [
    () => 10 * 2,
    () => 20 * 2,
    () => 30 * 2
] ).get();
writeOutput( results.toString() );

Result: [20, 40, 60]

Related

• AsyncAllApply
• AsyncAny
• AsyncRun
• ExecutorDelete
• ExecutorGet
• ExecutorHas
• ExecutorList
• ExecutorNew
• ExecutorShutdown
• ExecutorStatus
• FutureNew
• IsInThread
• isThreadAlive
• IsThreadInterrupted
• RunAsync
• ThreadCurrent
• ThreadInterrupt
• ThreadJoin
• ThreadNew
• ThreadTerminate