trusty (3) auth.3erl.gz

Provided by: erlang-manpages_16.b.3-dfsg-1ubuntu2.2_all bug

NAME

       auth - Erlang Network Authentication Server

DESCRIPTION

       This  module  is deprecated. For a description of the Magic Cookie system, refer to Distributed Erlang in
       the Erlang Reference Manual.

DATA TYPES

       cookie() = atom()

EXPORTS

       is_auth(Node) -> yes | no

              Types:

                 Node = node()

              Returns yes if communication with Node is authorized. Note that  a  connection  to  Node  will  be
              established in this case. Returns no if Node does not exist or communication is not authorized (it
              has another cookie than auth thinks it has).

              Use net_adm:ping(Node) instead.

       cookie() -> Cookie

              Types:

                 Cookie = cookie()

              Use erlang:get_cookie() instead.

       cookie(TheCookie) -> true

              Types:

                 TheCookie = Cookie | [Cookie]
                    The cookie may also be given as a list with a single atom element.
                 Cookie = cookie()

              Use erlang:set_cookie(node(), Cookie) instead.

       node_cookie([Node, Cookie]) -> yes | no

              Types:

                 Node = node()
                 Cookie = cookie()

              Equivalent to node_cookie(Node, Cookie).

       node_cookie(Node, Cookie) -> yes | no

              Types:

                 Node = node()
                 Cookie = cookie()

              Sets the magic cookie of Node to Cookie, and verifies the status of the authorization.  Equivalent
              to calling erlang:set_cookie(Node, Cookie), followed by auth:is_auth(Node).