gen_queue

v0.1.8

gen_queue v0.1.8 GenQueue.Job View Source

Link to this section Summary

Types

config()

Any additional configuration that is adapter-specific

delay()

A delay to schedule the job with

job()

Details on how and what to enqueue a job with

options()

Options for enqueuing jobs

queue()

The name of a queue to place the job under

t()

Functions

new(module, opts \\ [])
new(module, args, opts)

Link to this section Types

Link to this type config() View Source 
config() :: list() | nil

Any additional configuration that is adapter-specific

Link to this type delay() View Source 
delay() :: integer() | DateTime.t() | nil

A delay to schedule the job with

Link to this type job() View Source 
job() :: module() | {module()} | {module(), list()} | {module(), any()}

Details on how and what to enqueue a job with

Link to this type options() View Source 
options() :: [delay: delay(), queue: queue(), config: config()]

Options for enqueuing jobs

Link to this type queue() View Source 
queue() :: binary() | atom() | nil

The name of a queue to place the job under

Link to this type t() View Source 
t() :: %GenQueue.Job{
  args: list(),
  config: config(),
  delay: delay(),
  module: module(),
  queue: queue()
}

Link to this section Functions

Link to this function new(module, opts \\ []) View Source 
new(job(), options()) :: GenQueue.Job.t()
Link to this function new(module, args, opts) View Source 
new(module(), list(), options()) :: GenQueue.Job.t()