2.5.
CLASS: TASK
CHAPTER 2.
API REFERENCE
RO
run
error info
string Set
if the task has failed, this field
contains the set of associated error
strings. Undefined otherwise.
RW
other config
(string
→
string) Map
additional configuration
2.5.2
RPCs associated with class: task
RPC name: create
Overview:
Create a new task object which must be manually destroyed.
Signature:
(task ref) create (session_id s, string label, string description)
Arguments:
type
name
description
string
label
short label for the new task
string
description
longer description for the new task
Return Type:
task ref
The reference of the created task object
RPC name: destroy
Overview:
Destroy the task object.
Signature:
void destroy (session_id s, task ref self)
Arguments:
type
name
description
task ref
self
Reference to the task object
Return Type:
void
RPC name: cancel
Overview:
Request that a task be cancelled. Note that a task may fail to be cancelled and may complete or
fail normally and note that, even when a task does cancel, it might take an arbitrary amount of
time.
Signature:
void cancel (session_id s, task ref task)
Arguments:
type
name
description
task ref
task
The task
Return Type:
void
27
