Skip to content

Latest commit

History

History
29 lines (18 loc) 路 1.62 KB

api.md

File metadata and controls

29 lines (18 loc) 路 1.62 KB

API

Please see the Honeydew 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, then resume with resume/1.

Cancelling Jobs

To cancel a job that hasn't yet run, use cancel/1|2.

See the included example.

Moving Jobs

You can move a job from one queue to another, if it hasn't been started yet, with move/2.

Listing Jobs

You can list (and optionally filter the list) of jobs in a queue with filter/2.

See the included example.

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.

Job Replies

By passing reply: true to async/3, you can recieve replies from your jobs with yield/2.

See the included example