TTMSMCPTaskStatus Enumeration

Lifecycle state of a long-running operation. tsWorking means the operation is still running, tsInputRequired means it is paused until the client supplies additional input, tsCompleted means it finished and a result is available, tsFailed means it ended with an error, and tsCancelled means it was stopped before finishing.

API unit family: TMS.MCP.Tasks

Remarks

The last three states are terminal: once one of them is reached, the state no longer changes and further status updates are ignored.

Members

Name	Description
tsWorking	The operation is running and no result is available yet. It is the state a newly accepted operation starts in, the state an unrecognized state name falls back to, and the state an operation returns to once the input it was waiting for has been supplied. Written as working on the wire.
tsInputRequired	The operation is paused until the client supplies additional input. It is reached from the running state when the operation asks the client for values, and is left again for the running state once that exchange ends. Written as input-required on the wire.
tsCompleted	The operation finished and its result is available. It is reached when a result is stored for the operation, and is final: a request for the outcome returns that result. Written as completed on the wire.
tsFailed	The operation ended with an error. It is reached when an error is stored for the operation, and is final: a request for the outcome returns that error instead of a result. Written as failed on the wire.
tsCancelled	The operation was stopped before it finished. It is reached when the client asks for cancellation, which is refused once any final state has been reached, and is itself final. Written as cancelled on the wire.