DispatchJob¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A handle on one execution of a DISPATCH block, used to ask after it or cancel it from another script
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| DispatchJob | cancel() | Boolean | Asks for this job to stop, returning true only if the request was accepted. A job that has not been sent yet, has already been asked to stop, or has already finished can not be cancelled |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| DispatchJob | getEndTime() | UTCN | Returns when this job answered, however it answered, or null while it has not. Asking for a cancel does not set this; what comes back does |
| DispatchJob | getStartTime() | UTCN | Returns when this job's work went out, or null while it is still PENDING and nothing has been sent |
| DispatchJob | getState() | String | Returns current state. Either: PENDING, RUNNING, CANCELLING, COMPLETE, CANCELLED, ERROR |
| Object | toJson() | String | Returns a string of a json representation of this object. |
Method Definitions¶
cancel()¶
Boolean DispatchJob::cancel()
Description¶
Asks for this job to stop, returning true only if the request was accepted. A job that has not been sent yet, has already been asked to stop, or has already finished can not be cancelled
getClassName()¶
Description¶
Returns the string name of this object's class type.
getEndTime()¶
UTCN DispatchJob::getEndTime()
Description¶
Returns when this job answered, however it answered, or null while it has not. Asking for a cancel does not set this; what comes back does
getStartTime()¶
UTCN DispatchJob::getStartTime()
Description¶
Returns when this job's work went out, or null while it is still PENDING and nothing has been sent
getState()¶
String DispatchJob::getState()
Description¶
Returns current state. Either: PENDING, RUNNING, CANCELLING, COMPLETE, CANCELLED, ERROR
toJson()¶
Description¶
Returns a string of a json representation of this object.