erl_boot_server(3)

MODULE
erl_boot_server - Boot Server for Other Erlang Machines

DESCRIPTION

This server is used to assist diskless Erlang nodes which fetch all Erlang code from another machine.

This server is used to fetch all code, including the start script, if an Erlang runtime system is started with the -loader inet command line flag. All hosts specified with the -hosts Host command line flag must have one instance of this server running.

This server can be started with the kernel configuration parameter start_boot_server.

The erl_boot_server can both read regular files as well as files in archives. See code(3) and erl_prim_loader(3).

  Warning:

The support for loading of code from archive files is experimental. The sole purpose of releasing it before it is ready is to obtain early feedback. The file format, semantics, interfaces etc. may be changed in a future release.

EXPORTS

start(Slaves) -> {ok, Pid} | {error, What}

    Types
        Slaves = [Host]
        Host = atom()
        Pid = pid()
        What = term()

    Starts the boot server. Slaves is a list of IP addresses for hosts which are allowed to use this server as a boot server.

start_link(Slaves) -> {ok, Pid} | {error, What}

    Types
        Slaves = [Host]
        Host = atom()
        Pid = pid()
        What = term()()

    Starts the boot server and links to the caller. This function is used to start the server if it is included in a supervision tree.

add_slave(Slave) -> ok | {error, What}

    Types
        Slave = Host
        Host = atom()
        What = term()

    Adds a Slave node to the list of allowed slave hosts.

delete_slave(Slave) -> ok | {error, What}

    Types
        Slave = Host
        Host = atom()
        What = void()

    Deletes a Slave node from the list of allowed slave hosts.

which_slaves() -> Slaves

    Types
        Slaves = [Host]
        Host = atom()

    Returns the current list of allowed slave hosts.

SEE ALSO

init(3), erl_prim_loader(3)