Package ortus.boxlang.runtime.bifs.global.async

Class ExecutorShutdown

java.lang.Object

ortus.boxlang.runtime.bifs.BIF

ortus.boxlang.runtime.bifs.global.async.ExecutorShutdown

@BoxBIF
public class ExecutorShutdown
extends BIF

Field Summary

Fields inherited from class ortus.boxlang.runtime.bifs.BIF

__functionName, __isMemberExecution, asyncService, cacheService, componentService, declaredArguments, functionService, interceptorService, moduleService, runtime

Constructor Summary

Constructors

Constructor	Description
ExecutorShutdown()	Constructor

Method Summary

Modifier and Type	Method	Description
Boolean	_invoke(IBoxContext context, ArgumentsScope arguments)	Shuts down an executor by name.

Methods inherited from class ortus.boxlang.runtime.bifs.BIF

announce, getDeclaredArguments, invoke

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutorShutdown

public ExecutorShutdown()

Constructor

Method Details

_invoke

public Boolean _invoke(IBoxContext context,
 ArgumentsScope arguments)

Shuts down an executor by name. By default the executors are shutdown gracefully. However, if you want to force the shutdown you can set the force argument to true. If you want to wait for the executor to shutdown you can set the timeout argument to the number of milliseconds to wait.

Specified by:

_invoke in class BIF

Parameters:

context - The context in which the BIF is being invoked.

arguments - Argument scope for the BIF.

Returns:

The result of the invocation

Throws:

KeyNotFoundException - If the executor is not found.