Class: ExecutionFuture

ExecutionFuture

This object provides information about the background execution process created by executeBackground object. This object can be created using the executionId from other source, i.e. var otherFuture= new ExecutionFuture(otherExecutionId);

Constructor

new ExecutionFuture()

Properties:
Name Type Description
executionId ExecutionId The execution id internally used to describe the operation.
statementResult StatementResult The last known statement result.
Source:

Methods

cancel(mayInterruptopt, callbackopt)

Attempts to cancel execution of this statement. Returns false if the statement could not be cancelled, possibly because it has already finished. If the statement has not succeeded already, and can be stopped, the operation will transition to the FAILED state.
Parameters:
Name Type Attributes Description
mayInterrupt bool <optional>
 Option that allows to interrupt the execution.
callback cancelCallback <optional>
 A function that is called when the process is cancelled or the cancellation process failed.
Source:

get(callbackopt)

This method call the method specified in the callback parameter until the command represented by the execution id completes. Returns information about the execution of the statement.
Parameters:
Name Type Attributes Description
callback getCallback <optional>
 A function that is called when the process is cancelled or the cancellation process failed.
Source:

updateStatus(callbackopt)

Returns information about the execution of the statement. If the statement is still executing, this call will result in communication with the kvstore server to obtain up to date status, and the status returned will reflect interim information.
Parameters:
Name Type Attributes Description
callback updateStatusCallback <optional>
 A function that is called with information about the process.
Source: