From 5a485461a1157fef1bb3ce8426bfd1ad57b5ca52 Mon Sep 17 00:00:00 2001 From: Hans Bolinder Date: Fri, 6 May 2011 16:01:56 +0200 Subject: Use Erlang specs and types for documentation --- lib/kernel/doc/src/net_adm.xml | 74 +++++++++++++----------------------------- 1 file changed, 23 insertions(+), 51 deletions(-) (limited to 'lib/kernel/doc/src/net_adm.xml') diff --git a/lib/kernel/doc/src/net_adm.xml b/lib/kernel/doc/src/net_adm.xml index 7ec4f7f0e7..f2aac9282c 100644 --- a/lib/kernel/doc/src/net_adm.xml +++ b/lib/kernel/doc/src/net_adm.xml @@ -4,7 +4,7 @@
- 19962009 + 19962011 Ericsson AB. All Rights Reserved. @@ -34,94 +34,70 @@ - dns_hostname(Host) -> {ok, Name} | {error, Host} + Official name of a host - - Host = atom() | string() - Name = string() - -

Returns the official name of Host, or - {error, Host} if no such name is found. See also +

Returns the official name of Host, or + {error, Host} if no such name is found. See also inet(3).

 - host_file() -> Hosts | {error, Reason} + Read the .hosts.erlangfile - - Hosts = [Host] -  Host = atom() - Reason = term() -

Reads the .hosts.erlang file, see the section Files below. Returns the hosts in this file as a - list, or returns {error, Reason} if the file could not - be read. See file(3) for possible values of - Reason.

+ list, or returns {error, Reason} if the file could not + be read or the Erlang terms on the file could not be interpreted.

 - localhost() -> Name + Name of the local host - - Name = string() -

Returns the name of the local host. If Erlang was started - with the -name command line flag, Name is + with the -name command line flag, Name is the fully qualified name.

 - names() -> {ok, [{Name, Port}]} | {error, Reason} - names(Host) -> {ok, [{Name, Port}]} | {error, Reason} + + Names of Erlang nodes at a host - - Name = string() - Port = int() - Reason = address | term() -

Similar to epmd -names, see epmd(1). - Host defaults to the local host. Returns the names and + Host defaults to the local host. Returns the names and associated port numbers of the Erlang nodes that epmd at the specified host has registered.

Returns {error, address} if epmd is not - running. See inet(3) for other possible values of - Reason.

+ running.

 (arne@dunn)1> net_adm:names().
 {ok,[{"arne",40262}]}
 - ping(Node) -> pong | pang + Set up a connection to a node - - Node = node() - -

Tries to set up a connection to Node. Returns +

Tries to set up a connection to Node. Returns pang if it fails, or pong if it is successful.

 - world() -> [node()] - world(Arg) -> [node()] + + + Lookup and connect to all nodes at all hosts in .hosts.erlang - - Arg = silent | verbose -

This function calls names(Host) for all hosts which are specified in the Erlang host file .hosts.erlang, collects the replies and then evaluates ping(Node) on all those nodes. Returns the list of all nodes that were, successfully pinged.

-

Arg defaults to silent. - If Arg == verbose, the function writes information about which +

Arg defaults to silent. + If Arg == verbose, the function writes information about which nodes it is pinging to stdout.

This function can be useful when a node is started, and the names of the other nodes in the network are not initially @@ -131,14 +107,10 @@ - world_list(Hosts) -> [node()] - world_list(Hosts, Arg) -> [node()] + + + Lookup and connect to all nodes at specified hosts - - Hosts = [Host] -  Host = atom() - Arg = silent | verbose -

As world/0,1, but the hosts are given as argument instead of being read from .hosts.erlang.

-- cgit v1.2.3