/ 
TaskPipe-0.04
River stage zero No dependents
/ TaskPipe::Task::Settings

NAME

TaskPipe::Task::Settings - Settings for TaskPipe::Task

METHODS

plan_mode

The format that taskpipe expects to find your plan in. There are 2 modes, tree and branch. If your tasks will always be executed in order (ie your plan is completely linear) then this is the mode to choose. This way you can write your plan thus:

---

- name: Scrape_Example
  url: www.example.com

- name: Record
  example_param: $this

tree format is slightly more complex, offering the ability to execute different tasks in parallel (ie the plan can have more than one branch). In tree format, tasks should be designated using the keyword task: and cascaded using pipe_to:. For example:

---
task:
    _name: Scrape_Example
    url: www.example.com

pipe_to:
    task:
        name: Record
        example_param: $this

An example of how to achieve branching in tree format is as follows:

---
task:
    _name: Scrape_Example
    url: www.example.com

pipe_to:

    - task:
        name: Record
        example_param: $this

    - task:
        name: Scrape_SomethingElse
        another_param: $this[1]

The tasks Record and Scrape_SomethingElse execute in parallel. See the general documentation for more information on plan modes and branching

cache_results

Cache xtask results. This prevents the same xtask (ie the same task with the same pinterp being executed again (the results will just be piped to the next task without the task being executed).

threads

The maximum number of threads to use when running a plan. Taskpipe tries to adhere strictly to the number of threads you specify here - so parent threads are included in the value. You should experiment with your setup to determine the optimum value for your system

on_task_error

What to do if an error is encountered. Options are stop (ie attempt to stop all threads), and continue (which will log the error and continue)

AUTHOR

Tom Gracey <tomgracey@gmail.com>

COPYRIGHT AND LICENSE

Copyright (c) Tom Gracey 2018

TaskPipe is free software, licensed under

The GNU Public License Version 3