View Source SpawnCoElixir (SpawnCoElixir v0.2.0)

SpawnCoElixir spawns cooperative Elixir nodes that are supervised.

Summary

Types

The CoElixir server option

Functions

Starts a supervised CoElixir worker.

Stops a CoElixir worker by node name.

Lists all running CoElixir worker nodes.

Types

@type co_elixir_option() ::
  {:code, binary()}
  | {:deps, [atom() | tuple()]}
  | {:host_name, binary()}
  | {:co_elixir_name, binary()}

The CoElixir server option

  • :code - Elixir code to be run by CoElixir.Worker
  • :deps - dependencies for CoElixir.Worker
  • :host_name - the node name prefix for host
  • :co_elixir_name - the node name prefix for CoElixir

Functions

Starts a supervised CoElixir worker.

@spec stop(node()) :: :ok

Stops a CoElixir worker by node name.

@spec workers() :: [node()]

Lists all running CoElixir worker nodes.