Packages

honeydew

1.3.0
1.5.0 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.0 1.2.8 1.2.7 1.2.6 1.2.5 1.2.4 1.2.3 1.2.2 1.2.1 1.2.0 1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 1.0.0-rc7 1.0.0-rc6 1.0.0-rc5 1.0.0-rc4 1.0.0-rc3 1.0.0-rc2 1.0.0-rc1 0.0.11 0.0.10 0.0.9 0.0.8 0.0.7 0.0.6 0.0.5 0.0.4 0.0.3 0.0.2 0.0.1

Pluggable local/clusterable job queue focused on safety.

HexDocs

Current section

Files

Jump to
Readme
48 Versions
1 Dependency
3 Dependants
Files
Activity
honeydew README api.md
Raw

README/api.md 

# API



Please see the [Honeydew](https://hexdocs.pm/honeydew/Honeydew.html) module's hexdocs for Honeydew's complete API.



### Suspend and Resume

You can suspend a queue (halt the distribution of new jobs to workers), by calling [suspend/1](https://hexdocs.pm/honeydew/Honeydew.html#suspend/1), then resume with [resume/1](https://hexdocs.pm/honeydew/Honeydew.html#resume/1).



### Cancelling Jobs

To cancel a job that hasn't yet run, use [cancel/1|2](https://hexdocs.pm/honeydew/Honeydew.html#cancel/1).



See the included [example](https://github.com/koudelka/honeydew/blob/centralize/examples/filter_and_cancel.exs).



### Moving Jobs

You can move a job from one queue to another, if it hasn't been started yet, with [move/2](https://hexdocs.pm/honeydew/Honeydew.html#move/2).



### Listing Jobs

You can list (and optionally filter the list) of jobs in a queue with [filter/2](https://hexdocs.pm/honeydew/Honeydew.html#filter/2).



See the included [example](https://github.com/koudelka/honeydew/blob/centralize/examples/filter_and_cancel.exs).



### Job Progress

Your jobs can emit their current status, i.e. "downloaded 10/50 items", using the `progress/1` function given to your job module by `use Honeydew.Progress`.



See the included [example](https://github.com/koudelka/honeydew/blob/centralize/examples/progress_and_queue_status.exs).



### Job Replies

By passing `reply: true` to [async/3](https://hexdocs.pm/honeydew/Honeydew.html#async/3), you can recieve replies from your jobs with [yield/2](https://hexdocs.pm/honeydew/Honeydew.html#yield/2).



See the included [example](https://github.com/koudelka/honeydew/blob/centralize/examples/job_replies.exs)