Search documentation of Orchid

# Orchid.Executor behaviour (Orchid v0.3.3)

View Source

Executor behavoir.

An executor receive a `Orchid.Scheduler.Context` struct and do execution.

There're some functions recommend to use during execution.

- `Orchid.Scheduler.next_ready_steps/1`
- `Orchid.Scheduler.merge_result/3`
- `Orchid.Scheduler.mark_running_steps/3`

# Summary

## Types

executor()
executor_opts()
response()

## Callbacks

execute(t, executor_opts)

# Types

# executor()

    @type executor() :: module()

# executor_opts()

    @type executor_opts() :: keyword()

# response()

    @type response() :: {:ok, Orchid.Scheduler.Context.param_map()} | {:error, term()}

# Callbacks

# execute(t, executor_opts)

    @callback execute(Orchid.Scheduler.Context.t(), executor_opts()) :: response()