Merge pull request #1645 from Zorbash/document-inet-i

OTP:13713: Add documentation and typespecs for inet:i/0

2 files changed, 63 insertions, 2 deletions

diff --git a/lib/kernel/doc/src/inet.xml b/lib/kernel/doc/src/inet.xml
index 169a76463b..abb045b744 100644
--- a/lib/kernel/doc/src/inet.xml
+++ b/lib/kernel/doc/src/inet.xml
@@ -197,6 +197,9 @@ fe80::204:acff:fe17:bf38
     <datatype>
       <name name="address_family"/>
     </datatype>
+    <datatype>
+      <name name="socket_protocol"/>
+    </datatype>
   </datatypes>
 
   <funcs>
@@ -461,6 +464,61 @@ get_tcpi_sacked(Sock) ->
     </func>
 
     <func>
+      <name name="i" arity="0" />
+      <name name="i" arity="1" />
+      <name name="i" arity="2" />
+      <fsummary>Displays information and statistics about sockets on the terminal</fsummary>
+      <desc>
+        <p>
+          Lists all TCP, UDP and SCTP sockets, including those that the Erlang runtime system uses as well as
+          those created by the application.
+        </p>
+        <p>
+          The following options are available:
+        </p>
+
+        <taglist>
+          <tag><c>port</c></tag>
+          <item>
+            <p>The internal index of the port.</p>
+          </item>
+          <tag><c>module</c></tag>
+          <item>
+            <p>The callback module of the socket.</p>
+          </item>
+          <tag><c>recv</c></tag>
+          <item>
+            <p>Number of bytes received by the socket.</p>
+          </item>
+          <tag><c>sent</c></tag>
+          <item>
+            <p>Number of bytes sent from the socket.</p>
+          </item>
+          <tag><c>owner</c></tag>
+          <item>
+            <p>The socket owner process.</p>
+          </item>
+          <tag><c>local_address</c></tag>
+          <item>
+            <p>The local address of the socket.</p>
+          </item>
+          <tag><c>foreign_address</c></tag>
+          <item>
+            <p>The address and port of the other end of the connection.</p>
+          </item>
+          <tag><c>state</c></tag>
+          <item>
+            <p>The connection state.</p>
+          </item>
+          <tag><c>type</c></tag>
+          <item>
+            <p>STREAM or DGRAM or SEQPACKET.</p>
+          </item>
+        </taglist>
+      </desc>
+    </func>
+
+    <func>
       <name name="ntoa" arity="1" />
       <fsummary>Convert IPv6/IPV4 address to ASCII.</fsummary>
       <desc>
@@ -1214,7 +1272,7 @@ inet:setopts(Sock,[{raw,6,8,<<30:32/native>>}]),]]></code>
 	  For one-to-many style sockets, the special value <c>0</c>
 	  is defined to mean that the returned addresses must be
 	  without any particular association.
-	  How different SCTP implementations interprets this varies somewhat.
+	  How different SCTP implementations interpret this varies somewhat.
         </p>
       </desc>
     </func>
diff --git a/lib/kernel/src/inet.erl b/lib/kernel/src/inet.erl
index dc20c21c77..fe91b0d33e 100644
--- a/lib/kernel/src/inet.erl
+++ b/lib/kernel/src/inet.erl
@@ -72,7 +72,7 @@
 %% timer interface
 -export([start_timer/1, timeout/1, timeout/2, stop_timer/1]).
 
--export_type([address_family/0, hostent/0, hostname/0, ip4_address/0,
+-export_type([address_family/0, socket_protocol/0, hostent/0, hostname/0, ip4_address/0,
               ip6_address/0, ip_address/0, port_number/0,
 	      local_address/0, socket_address/0, returned_non_ip_address/0,
 	      socket_setopt/0, socket_getopt/0,
@@ -1452,11 +1452,14 @@ fdopen(Fd, Addr, Port, Opts, Protocol, Family, Type, Module) ->
 %%  socket stat
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+-spec i() -> ok.
 i() -> i(tcp), i(udp), i(sctp).
 
+-spec i(socket_protocol()) -> ok.
 i(Proto) -> i(Proto, [port, module, recv, sent, owner,
 		      local_address, foreign_address, state, type]).
 
+-spec i(socket_protocol(), [atom()]) -> ok.
 i(tcp, Fs) ->
     ii(tcp_sockets(), Fs, tcp);
 i(udp, Fs) ->