Olympe SDK

Class: SequencedExecutor

olympe.async. SequencedExecutor

SequencedExecutor executes all the tasks one after the other in the order submitted. If one of its tasks fails (calls the end() function), it stops the execution pool, and triggers the callbacks immediately.

new SequencedExecutor()

Extends

Members

<protected, non-null> callbacks :Array.<function(boolean, ?string, Map.<string, *>)>

Type:
  • Array.<function(boolean, ?string, Map.<string, *>)>
Inherited From:

<protected> ended :boolean

Type:
  • boolean
Inherited From:

<protected, non-null> env :Map.<string, *>

Type:
  • Map.<string, *>
Inherited From:

<protected, nullable> errorMsg :string

Type:
  • string
Inherited From:
Overrides:

<protected> logger :olympe.logging.Channel

Type:
  • olympe.logging.Channel
Inherited From:

<protected> started :boolean

Type:
  • boolean
Inherited From:

<protected, non-null> tasks :Array.<olympe.async.Task>

Type:
Inherited From:

Methods

<static> create()

Creates a SequencedExecutor with an auto-destructing context.

Returns:
Type
olympe.async.SequencedExecutor

add(task)

Adds a task to this Executor. If the executor has already ended, this is ignored.

Parameters:
Name Type Description
task olympe.async.Task

The task to add.
Inherited From:
Returns:

this Executor.

Type
olympe.async.Executor

<protected> clear()

Clears the executor: remove all tasks and callbacks.

Inherited From:

<protected> complete(success)

Notifies the end of the execution and triggers the callbacks.

Parameters:
Name Type Description
success boolean

Whether the execution was successful or not.
Inherited From:

getContext()

Gets the ExecutionContext associated with this Executor.

Inherited From:
Returns:
Type
olympe.df.ExecutionContext

getLogger()

Gets the logger attached to this Executor.

Inherited From:
Returns:

The attached logger.

Type
olympe.logging.Channel

hasEnded()

Checks whether this Executor has completed its execution.

Inherited From:
Returns:

true when the Executor has ended.

Type
boolean

insert(task)

Inserts a task at the top of this Executors list. If the Executor has already started this means this tasks will be executed after the current one. If the Executor has already ended (all its tasks have already completed), the task is ignored.

Parameters:
Name Type Description
task olympe.async.Task

The task to insert.
Returns:

this Executor

Type
olympe.async.SequencedExecutor

isRunning()

Checks whether this Executor is currently running one or more tasks.

Inherited From:
Returns:

true when the Executor is running.

Type
boolean

onEnd(callback)

Registers a callback to be called when the Executor has completed. The callback is passed a boolean, true if all the tasks completed successfully, false otherwise.

Parameters:
Name Type Description
callback function

The function to register.
Inherited From:
Returns:

this Executor.

Type
olympe.async.Executor

start()

Starts the executor. Does nothing if it had already been started.

Inherited From:
Overrides:

withLogger(logger)

Attach a logger to this executor.

Parameters:
Name Type Description
logger olympe.logging.Channel

The logger to attach.
Inherited From:
Returns:

this Executor.

Type
olympe.async.Executor

withTimeout(t)

Sets a timeout for the executor. If all the tasks in this Executor are not completed within the specified time the Executor will complete as failed. All pending tasks will be cancelled.

Parameters:
Name Type Description
t number

timeout in milliseconds.
Inherited From:
Returns:

this Executor.

Type
olympe.async.Executor