https://github.com/PSPDFKit-labs/sidetask

:awesome = Elixir's Task ++ Basho's sidejob library
https://github.com/PSPDFKit-labs/sidetask

Last synced: about 1 month ago
JSON representation

:awesome = Elixir's Task ++ Basho's sidejob library

• Host: GitHub
• URL: https://github.com/PSPDFKit-labs/sidetask
• Owner: PSPDFKit-labs
• License: mit
• Created: 2014-10-15T18:48:37.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-12T18:01:06.000Z (over 7 years ago)
• Last Synced: 2024-10-18T10:53:52.436Z (about 2 months ago)
• Language: Elixir
• Homepage:
• Size: 126 KB
• Stars: 72
• Watchers: 8
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - SideTask is an alternative to Task.Supervisor using Basho's sidejob library with parallelism and capacity limiting. (Cloud Infrastructure and Management)
• fucking-awesome-elixir - sidetask - SideTask is an alternative to Task.Supervisor using Basho's sidejob library with parallelism and capacity limiting. (Cloud Infrastructure and Management)
• awesome-elixir - sidetask - SideTask is an alternative to Task.Supervisor using Basho's sidejob library with parallelism and capacity limiting. (Cloud Infrastructure and Management)

README

        
SideTask

========

[![Build Status](https://travis-ci.org/PSPDFKit-labs/sidetask.svg)](https://travis-ci.org/PSPDFKit-labs/sidetask)

SideTask is an alternative to Elixir's

[Task.Supervisor](http://elixir-lang.org/docs/stable/elixir/Task.Supervisor.html) that uses Basho's

[sidejob](https://github.com/basho/sidejob) library for better parallelism and to support capacity

limiting of [Tasks](http://elixir-lang.org/docs/stable/elixir/Task.html).

Elixir's `Task.Supervisor` is implemented as a single `:simple_one_for_one` supervisor with the

individual `Task`s as children. This means starting a new task has to go through this single

supervisor. Furthermore there is no limit to the number of workers that can be running at the same

time.

Basho's sidejob library spawns multiple supervisors (one for each scheduler by default) and

uses ETS tables to keep track of the number of workers, thereby making it possible to start

workers in parallel while also putting an upper bound on the number of running workers.

SideTask provides an API similar to `Task.Supervisor`, with the addition that all calls that

start a new task require a sidejob resource as argument and can return `{:error, :overload}`.

Convenience functions for adding and deleting sidejob resources are provided.

## Example 1

```elixir

SideTask.add_resource(:example1, 50)

potential_tasks = for i <- 1..100 do

  case SideTask.async(:example1, fn -> :timer.sleep(1000); i end) do

    {:ok, task} ->

      IO.puts "Task #{i} created"

      task

    {:error, :overload} ->

      IO.puts "Task #{i} not created, overloaded"

      nil

  end

end

IO.inspect for task = %Task{} <- potential_tasks, do: Task.await(task)

```

## Example 2

```elixir

# Erlang spawns one scheduler per CPU core by default

schedulers = :erlang.system_info(:schedulers)

SideTask.add_resource(:example2, schedulers * 2)

for scheduler <- 1..schedulers do

  spawn_link fn ->

    for i <- Stream.iterate(0, &(&1+1)) do

      SideTask.start_child :example2, fn ->

        :timer.sleep(250);

        IO.inspect scheduler: scheduler, count: i

      end

    end

  end

end

```

![Observer while running example 2](https://raw.githubusercontent.com/MSch/sidetask/gh-pages/observer.png)

## License

This software is licensed under [the MIT license](LICENSE).

## About



  



This project is maintained and funded by [PSPDFKit](https://pspdfkit.com/).

See [our other open source projects](https://github.com/PSPDFKit-labs), read [our blog](https://pspdfkit.com/blog/) or say hello on Twitter ([@PSPDFKit](https://twitter.com/pspdfkit)).