Package ortus.boxlang.runtime.bifs.global.scheduler

Class SchedulerRestart

java.lang.Object

ortus.boxlang.runtime.bifs.BIF

ortus.boxlang.runtime.bifs.global.scheduler.SchedulerRestart

@BoxBIF(description="Restart a scheduled task")
public class SchedulerRestart
extends BIF

Field Summary

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

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

Constructor Summary

Constructors

Constructor	Description
SchedulerRestart()	Constructor

Method Summary

Modifier and Type	Method	Description
Object	_invoke(IBoxContext context, ArgumentsScope arguments)	Restart a scheduler 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

SchedulerRestart

public SchedulerRestart()

Constructor

Method Details

_invoke

public Object _invoke(IBoxContext context,
 ArgumentsScope arguments)

Restart a scheduler by name.

The default will do a graceful shutdown, but if the force argument is set to true, it will force shutdown the scheduler.

If the timeout argument is set, it will wait for the specified amount of time in seconds before forcing the shutdown. The default is 30 seconds.

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