wormhole v2.1.0 Wormhole
Invokes callback
in separate process and
waits for message from callback process containing callback return value
if finished successfully or
error reason if callback process failed.
If callback
execution is not finished within specified timeout,
kills callback
process and returns error.
Default timeout is 5000 milliseconds.
User can specify timeout
in options
keyword list.
By default if callback fails stacktrace will not be returned.
User can set stacktrace
option to true
and in that case stacktrace will
be returned in response.
Note: stacktrace
option works only if crush_report
is not enabled.
By default there is no retry, but user can specify
retry_count
and backoff_ms
in options
.
Default backoff_ms
is 1000 milliseconds.
By default exceptions in callback-process are handled so that
supervisor does not generate CRUSH REPORT (when released - Exrm/Distillery).
This behavior can be overridden by setting crush_report
to true
.
Note:
- Crush report is not generated in Elixir by default.
- Letting exceptions propagate might be useful for some other applications too (e.g sentry client).
Link to this section Summary
Link to this section Functions
Invokes callback in separate process.
Examples:
iex> capture(fn-> :a end)
{:ok, :a}
iex> capture(fn-> raise "Something happened" end)
{:error, {:shutdown, %RuntimeError{message: "Something happened"}}}
iex> capture(fn-> throw "Something happened" end)
{:error, {:shutdown, {:throw, "Something happened"}}}
iex> capture(fn-> exit :foo end)
{:error, {:shutdown, {:exit, :foo}}}
iex> capture(fn-> Process.exit(self(), :foo) end)
{:error, :foo}
iex> capture(fn-> :timer.sleep 20 end, timeout: 50)
{:ok, :ok}
iex> capture(fn-> :timer.sleep :infinity end, timeout: 50)
{:error, {:timeout, 50}}
iex> capture(fn-> exit :foo end, [retry_count: 3, backoff_ms: 100])
{:error, {:shutdown, {:exit, :foo}}}
Calls capture/2 internally.
Examples:
iex> capture(Enum, :count, [[]])
{:ok, 0}
iex> capture(Enum, :count, [:foo]) |> elem(0)
:error
iex> capture(:timer, :sleep, [20], timeout: 50)
{:ok, :ok}
iex> capture(:timer, :sleep, [:infinity], timeout: 50)
{:error, {:timeout, 50}}
iex> capture(Kernel, :exit, [:foos], [retry_count: 3, backoff_ms: 100])
{:error, {:shutdown, {:exit, :foos}}}