aboutsummaryrefslogtreecommitdiffstats
path: root/erts/doc
diff options
context:
space:
mode:
authorMicael Karlberg <[email protected]>2018-06-19 12:20:21 +0200
committerMicael Karlberg <[email protected]>2018-09-18 14:50:18 +0200
commit44cfb3d222ba4d20607af7cc654746f84ece3989 (patch)
tree8613e0736320ce8ea8a015b88d06194ffb91f1fe /erts/doc
parent1952754950f371f43ed4dd675a42c60b3d166bd7 (diff)
downloadotp-44cfb3d222ba4d20607af7cc654746f84ece3989.tar.gz
otp-44cfb3d222ba4d20607af7cc654746f84ece3989.tar.bz2
otp-44cfb3d222ba4d20607af7cc654746f84ece3989.zip
[socket-nif] Add doc for net module and some cleanup
Added doc for the net module. Also some socket-nif cleanup. OTP-14831
Diffstat (limited to 'erts/doc')
-rw-r--r--erts/doc/src/Makefile6
-rw-r--r--erts/doc/src/net.xml126
-rw-r--r--erts/doc/src/ref_man.xml1
-rw-r--r--erts/doc/src/specs.xml1
4 files changed, 132 insertions, 2 deletions
diff --git a/erts/doc/src/Makefile b/erts/doc/src/Makefile
index 1540344fde..9a2750b751 100644
--- a/erts/doc/src/Makefile
+++ b/erts/doc/src/Makefile
@@ -53,7 +53,8 @@ XML_REF3_EFILES = \
erl_tracer.xml \
init.xml \
zlib.xml \
- socket.xml
+ socket.xml \
+ net.xml
XML_REF3_FILES = \
driver_entry.xml \
@@ -65,7 +66,8 @@ XML_REF3_FILES = \
erts_alloc.xml \
init.xml \
zlib.xml \
- socket.xml
+ socket.xml \
+ net.xml
XML_PART_FILES = \
part.xml
diff --git a/erts/doc/src/net.xml b/erts/doc/src/net.xml
new file mode 100644
index 0000000000..c022fee4f7
--- /dev/null
+++ b/erts/doc/src/net.xml
@@ -0,0 +1,126 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!DOCTYPE erlref SYSTEM "erlref.dtd">
+
+<erlref>
+ <header>
+ <copyright>
+ <year>2018</year><year>2018</year>
+ <holder>Ericsson AB. All Rights Reserved.</holder>
+ </copyright>
+ <legalnotice>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+ </legalnotice>
+
+ <title>net</title>
+ <prepared></prepared>
+ <docno></docno>
+ <date></date>
+ <rev></rev>
+ <file>net.xml</file>
+ </header>
+ <module>net</module>
+ <modulesummary>Network interface.</modulesummary>
+ <description>
+ <p>This module provides an API for the network interface.</p>
+ </description>
+
+ <datatypes>
+ <datatype>
+ <name name="address_info"/>
+ </datatype>
+ <datatype>
+ <name name="name_info"/>
+ </datatype>
+ <datatype>
+ <name name="name_info_flags"/>
+ </datatype>
+ <datatype>
+ <name name="name_info_flag"/>
+ </datatype>
+ <datatype>
+ <name name="name_info_flag_ext"/>
+ </datatype>
+ <datatype>
+ <name name="network_interface_name"/>
+ </datatype>
+ <datatype>
+ <name name="network_interface_index"/>
+ </datatype>
+ </datatypes>
+
+ <funcs>
+ <func>
+ <name name="gethostname" arity="0"/>
+ <fsummary>Get hostname.</fsummary>
+ <desc>
+ <p>Returns the name of the current host.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="getnameinfo" arity="1"/>
+ <name name="getnameinfo" arity="2"/>
+ <fsummary>Address-to-name transaltion.</fsummary>
+ <desc>
+ <p>Address-to-name translation in a protocol-independant manner.</p>
+ <p>This function is the inverse of
+ <seealso marker="#getaddrinfo"><c>getaddrinfo</c></seealso>.
+ It converts a socket address to a corresponding host and service.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="getaddrinfo" arity="1"/>
+ <name name="getaddrinfo" arity="2" clause_i="1"/>
+ <name name="getaddrinfo" arity="2" clause_i="2"/>
+ <name name="getaddrinfo" arity="2" clause_i="3"/>
+ <fsummary>Network address and service transation.</fsummary>
+ <desc>
+ <p>Network address and service translation.</p>
+ <p>This function is the inverse of
+ <seealso marker="#getnameinfo"><c>getnameinfo</c></seealso>.
+ It converts host and service to a corresponding socket address.</p>
+ <p>One of the <c>Host</c> and <c>Service</c> may be <c>undefined</c>
+ but <em>not</em> both.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="if_name2index" arity="1"/>
+ <fsummary>Mappings between network interface names and indexes.</fsummary>
+ <desc>
+ <p>Mappings between network interface names and indexes.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="if_index2name" arity="1"/>
+ <fsummary>Mappings between network interface index and names.</fsummary>
+ <desc>
+ <p>Mappings between network interface index and names.</p>
+ </desc>
+ </func>
+
+ <func>
+ <name name="if_names" arity="0"/>
+ <fsummary>Get network interface names and indexes.</fsummary>
+ <desc>
+ <p>Get network interface names and indexes.</p>
+ </desc>
+ </func>
+
+ </funcs>
+
+</erlref>
+
diff --git a/erts/doc/src/ref_man.xml b/erts/doc/src/ref_man.xml
index da099dd5bb..ccbafb1530 100644
--- a/erts/doc/src/ref_man.xml
+++ b/erts/doc/src/ref_man.xml
@@ -36,6 +36,7 @@
<xi:include href="init.xml"/>
<xi:include href="zlib.xml"/>
<xi:include href="socket.xml"/>
+ <xi:include href="net.xml"/>
<xi:include href="epmd.xml"/>
<xi:include href="erl.xml"/>
<xi:include href="erlc.xml"/>
diff --git a/erts/doc/src/specs.xml b/erts/doc/src/specs.xml
index 4f6951a44b..6c12f619b1 100644
--- a/erts/doc/src/specs.xml
+++ b/erts/doc/src/specs.xml
@@ -5,5 +5,6 @@
<xi:include href="../specs/specs_erl_tracer.xml"/>
<xi:include href="../specs/specs_init.xml"/>
<xi:include href="../specs/specs_socket.xml"/>
+ <xi:include href="../specs/specs_net.xml"/>
<xi:include href="../specs/specs_zlib.xml"/>
</specs>