horde_connector v0.1.1 HordeConnector View Source

HordeConnector

This library must be used in conjunction with Horde. Horde by itself works in a well defined environment where all instances are known at startup. HordeConnector allows new BEAM nodes to be added to the Horde dynamically at runtime. Your application will still be responsible for linking nodes (we suggest using libcluster). Once linked, HordeConnector will automatically join nodes to Horde upon connection.

Installation

This package can be installed by adding horde_connector to your list of dependencies in mix.exs:

def deps() do
  [
    {:horde_connector, "~> 0.1.1"}
  ]
end

Configuration

HordeConnector currently only works with Horde Version 0.2.3

Configure Horde per their documentation HERE. Start HordeConnector under you application.

# application.ex
def start(_type, _args) do
  children = [
    # ....
    {Horde.Registry, [name: MyApp.Registry]},
    {Horde.Supervisor, [name: MyApp.Horde.Supervisor, strategy: :one_for_one]},
    {HordeConnector, [supervisor: MyApp.Horde.Supervisor, registry: MyApp.Registry]}
   ]

   # ....

   Supervisor.start_link(children, opts)
end

And that's it! Once HordeConnector is started, any time Node.connect/1 is called the new node will be added to the Horde cluster.

License

Released under Apache 2 license.

Link to this section Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor

init(hordes)

Invoked when the server is started. start_link/3 or start/3 will block until it returns

start_link(args, opts \\ [])

Link to this section Functions

child_spec(init_arg) View Source

Returns a specification to start this module under a supervisor.

See Supervisor.

init(hordes) View Source

Invoked when the server is started. start_link/3 or start/3 will block until it returns.

init_arg is the argument term (second argument) passed to start_link/3.

Returning {:ok, state} will cause start_link/3 to return {:ok, pid} and the process to enter its loop.

Returning {:ok, state, timeout} is similar to {:ok, state} except handle_info(:timeout, state) will be called after timeout milliseconds if no messages are received within the timeout.

Returning {:ok, state, :hibernate} is similar to {:ok, state} except the process is hibernated before entering the loop. See c:handle_call/3 for more information on hibernation.

Returning {:ok, state, {:continue, continue}} is similar to {:ok, state} except that immediately after entering the loop the c:handle_continue/2 callback will be invoked with the value continue as first argument.

Returning :ignore will cause start_link/3 to return :ignore and the process will exit normally without entering the loop or calling c:terminate/2. If used when part of a supervision tree the parent supervisor will not fail to start nor immediately try to restart the GenServer. The remainder of the supervision tree will be started and so the GenServer should not be required by other processes. It can be started later with Supervisor.restart_child/2 as the child specification is saved in the parent supervisor. The main use cases for this are:

The GenServer is disabled by configuration but might be enabled later.
An error occurred and it will be handled by a different mechanism than the Supervisor. Likely this approach involves calling Supervisor.restart_child/2 after a delay to attempt a restart.

Returning {:stop, reason} will cause start_link/3 to return {:error, reason} and the process to exit with reason reason without entering the loop or calling c:terminate/2.

Callback implementation for GenServer.init/1.

start_link(args, opts \\ []) View Source