RPC Interface

Root Interface

This RPC interface is exposed under a scope ROOT, which is configured using the control-uri commandline option. The interface provides the following methods:

loadStory(story)

Arguments:

• story (string) – Literal story definition (see Story Syntax)

Returns string:

Scope of story interface

Loads given story. Blocking until story interface set up.

loadStoryFromFile(filename)

Arguments:

• filename (string) – Name of file containing story definition.

Returns string:

Scope of story interface

Loads given story from given file. Blocking until story interface set up.

Story Interface

An individual RPC interface is provided for each loaded story object. Assuming the root RPC interface is exposed under ROOT, a story named NAME is exposed under the scope ROOT/NAME. The interface provides the following methods:

run()

Start execution and wait for finish. Returns result (e.g. success or number of errors).

cancel()

Cancel execution.

continue()

Continue story when waiting in a breakpoint.