duct v1.0.3

View Source Duct.Parallel (duct v1.0.3)

Link to this section Summary

Types

name()
run()
t()

Functions

new()

Returns an empty Duct.Parallel struct.

run(multi, name, run)

Adds a function to run parallel.

to_list(parallel)

Returns the list of operations stored in multi.

yield_many(tasks, timeout \\ 5000)

Link to this section Types

Link to this type

name()

View Source 
@type name() :: any()
Link to this type

run()

View Source 
@type run() :: (() -> {:ok | :error, any()} | any())
Link to this type

t()

View Source 
@type t() :: %Duct.Parallel{names: names(), operations: operations()}

Link to this section Functions

Link to this function

new()

View Source 
@spec new() :: t()

Returns an empty Duct.Parallel struct.

example

 Example 

iex> Duct.Parallel.new() |> Duct.Parallel.to_list()
[]
Link to this function

run(multi, name, run)

View Source 
@spec run(t(), name(), run()) :: t()

Adds a function to run parallel.

example

 Example 

Duct.Parallel.new()
|> Duct.Parallel.run("facebook", fn -> post(:facebook) end)
|> Duct.Parallel.run("twitter", fn -> post(:twitter) end)
|> Duct.run()
Link to this function

to_list(parallel)

View Source 
@spec to_list(t()) :: [{name(), term()}]

Returns the list of operations stored in multi.

Always use this function when you need to access the operations you have defined in Duct.Multi. Inspecting the Duct.Multi struct internals directly is discouraged.

Link to this function

yield_many(tasks, timeout \\ 5000)

View Source 
@spec yield_many([t()], number() | :infinity) :: [
  {t(), {:ok, term()} | {:exit, term()} | nil}
]