Merge branch 'hb/inet_types_and_specs/OTP-9260' into dev

* hb/inet_types_and_specs/OTP-9260:
  Improve types and specifications of the inet modules

1 files changed, 37 insertions, 110 deletions

diff --git a/lib/kernel/src/inet.erl b/lib/kernel/src/inet.erl
index 5649188c38..48a6f3db65 100644
--- a/lib/kernel/src/inet.erl
+++ b/lib/kernel/src/inet.erl
@@ -63,8 +63,9 @@
 %% timer interface
 -export([start_timer/1, timeout/1, timeout/2, stop_timer/1]).
 
--export_type([family_option/0, hostent/0, hostname/0, ip4_address/0,
-              ip6_address/0, ip_address/0, posix/0, socket/0]).
+-export_type([address_family/0, hostent/0, hostname/0, ip4_address/0,
+              ip6_address/0, ip_address/0, posix/0, socket/0,
+              port_number/0]).
 
 %% imports
 -import(lists, [append/1, duplicate/2, filter/2, foldl/3]).
@@ -87,98 +88,15 @@
 -type ip6_address() :: {0..65535,0..65535,0..65535,0..65535,
 			0..65535,0..65535,0..65535,0..65535}.
 -type ip_address() :: ip4_address() | ip6_address().
--type ip_port() :: 0..65535.
+-type port_number() :: 0..65535.
 -type posix() :: exbadport | exbadseq | file:posix().
 -type socket() :: port().
 
 -type socket_setopt() ::
-      {'raw', non_neg_integer(), non_neg_integer(), binary()} |
-      %% TCP/UDP options
-      {'reuseaddr',       boolean()} |
-      {'keepalive',       boolean()} |
-      {'dontroute',       boolean()} |
-      {'linger',          {boolean(), non_neg_integer()}} |
-      {'broadcast',       boolean()} |
-      {'sndbuf',          non_neg_integer()} |
-      {'recbuf',          non_neg_integer()} |
-      {'priority',        non_neg_integer()} |
-      {'tos',             non_neg_integer()} |
-      {'nodelay',         boolean()} |
-      {'multicast_ttl',   non_neg_integer()} |
-      {'multicast_loop',  boolean()} |
-      {'multicast_if',    ip_address()} |
-      {'add_membership',  {ip_address(), ip_address()}} |
-      {'drop_membership', {ip_address(), ip_address()}} |
-      {'header',          non_neg_integer()} |
-      {'buffer',          non_neg_integer()} |
-      {'active',          boolean() | 'once'} |
-      {'packet',        
-       0 | 1 | 2 | 4 | 'raw' | 'sunrm' |  'asn1' |
-       'cdr' | 'fcgi' | 'line' | 'tpkt' | 'http' | 'httph' | 'http_bin' | 'httph_bin' } |
-      {'mode',           'list' | 'binary'} |
-      {'port',           'port', 'term'} |
-      {'exit_on_close',   boolean()} |
-      {'low_watermark',   non_neg_integer()} |
-      {'high_watermark',  non_neg_integer()} |
-      {'bit8',            'clear' | 'set' | 'on' | 'off'} |
-      {'send_timeout',    non_neg_integer() | 'infinity'} |
-      {'send_timeout_close', boolean()} |
-      {'delay_send',      boolean()} |
-      {'packet_size',     non_neg_integer()} |
-      {'read_packets',    non_neg_integer()} |
-      %% SCTP options
-      {'sctp_rtoinfo',               #sctp_rtoinfo{}} |
-      {'sctp_associnfo',             #sctp_assocparams{}} |
-      {'sctp_initmsg',               #sctp_initmsg{}} |
-      {'sctp_nodelay',               boolean()} |
-      {'sctp_autoclose',             non_neg_integer()} |
-      {'sctp_disable_fragments',     boolean()} |
-      {'sctp_i_want_mapped_v4_addr', boolean()} |
-      {'sctp_maxseg',                non_neg_integer()} |
-      {'sctp_primary_addr',          #sctp_prim{}} |
-      {'sctp_set_peer_primary_addr', #sctp_setpeerprim{}} |
-      {'sctp_adaptation_layer',      #sctp_setadaptation{}} |
-      {'sctp_peer_addr_params',      #sctp_paddrparams{}} |
-      {'sctp_default_send_param',    #sctp_sndrcvinfo{}} |
-      {'sctp_events',                #sctp_event_subscribe{}} |
-      {'sctp_delayed_ack_time',      #sctp_assoc_value{}}.
+        gen_sctp:option() | gen_tcp:option() | gen_udp:option().
 
 -type socket_getopt() ::
-      {'raw',
-       non_neg_integer(), non_neg_integer(), binary()|non_neg_integer()} |
-      %% TCP/UDP options
-      'reuseaddr' | 'keepalive' | 'dontroute' | 'linger' |
-      'broadcast' | 'sndbuf' | 'recbuf' | 'priority' | 'tos' | 'nodelay' | 
-      'multicast_ttl' | 'multicast_loop' | 'multicast_if' | 
-      'add_membership' | 'drop_membership' | 
-      'header' | 'buffer' | 'active' | 'packet' | 'mode' | 'port' | 
-      'exit_on_close' | 'low_watermark' | 'high_watermark' | 'bit8' | 
-      'send_timeout' | 'send_timeout_close' |
-      'delay_send' | 'packet_size' | 'read_packets' | 
-      %% SCTP options
-      {'sctp_status',                #sctp_status{}} |
-      'sctp_get_peer_addr_info' |
-      {'sctp_get_peer_addr_info',    #sctp_status{}} |
-      'sctp_rtoinfo' |
-      {'sctp_rtoinfo',               #sctp_rtoinfo{}} |
-      'sctp_associnfo' |
-      {'sctp_associnfo',             #sctp_assocparams{}} |
-      'sctp_initmsg' |
-      {'sctp_initmsg',               #sctp_initmsg{}} |
-      'sctp_nodelay' | 'sctp_autoclose' | 'sctp_disable_fragments' |
-      'sctp_i_want_mapped_v4_addr' | 'sctp_maxseg' |
-      {'sctp_primary_addr',          #sctp_prim{}} |
-      {'sctp_set_peer_primary_addr', #sctp_setpeerprim{}} |
-      'sctp_adaptation_layer' |
-      {'sctp_adaptation_layer',      #sctp_setadaptation{}} |
-      {'sctp_peer_addr_params',      #sctp_paddrparams{}} |
-      'sctp_default_send_param' |
-      {'sctp_default_send_param',    #sctp_sndrcvinfo{}} |
-      'sctp_events' |
-      {'sctp_events',                #sctp_event_subscribe{}} |
-      'sctp_delayed_ack_time' |
-      {'sctp_delayed_ack_time',      #sctp_assoc_value{}}.
-
+        gen_sctp:option_name() | gen_tcp:option_name() | gen_udp:option_name().
 -type ether_address() :: [0..255].
 
 -type if_setopt() ::
@@ -196,7 +114,7 @@
       'addr' | 'broadaddr' | 'dstaddr' | 
       'mtu' | 'netmask' | 'flags' |'hwaddr'.
 
--type family_option() :: 'inet' | 'inet6'.
+-type address_family() :: 'inet' | 'inet6'.
 -type protocol_option() :: 'tcp' | 'udp' | 'sctp'.
 -type stat_option() :: 
 	'recv_cnt' | 'recv_max' | 'recv_avg' | 'recv_oct' | 'recv_dvi' |
@@ -229,7 +147,7 @@ close(Socket) ->
 peername(Socket) -> 
     prim_inet:peername(Socket).
 
--spec setpeername(Socket :: socket(), Address :: {ip_address(), ip_port()}) ->
+-spec setpeername(Socket :: socket(), Address :: {ip_address(), port_number()}) ->
 	'ok' | {'error', any()}.
 
 setpeername(Socket, {IP,Port}) ->
@@ -246,7 +164,7 @@ setpeername(Socket, undefined) ->
 sockname(Socket) -> 
     prim_inet:sockname(Socket).
 
--spec setsockname(Socket :: socket(), Address :: {ip_address(), ip_port()}) ->
+-spec setsockname(Socket :: socket(), Address :: {ip_address(), port_number()}) ->
 	'ok' | {'error', any()}.
 
 setsockname(Socket, {IP,Port}) -> 
@@ -254,7 +172,9 @@ setsockname(Socket, {IP,Port}) ->
 setsockname(Socket, undefined) ->
     prim_inet:setsockname(Socket, undefined).
 
--spec port(Socket :: socket()) -> {'ok', ip_port()} | {'error', any()}.
+-spec port(Socket) -> {'ok', Port} | {'error', any()} when
+      Socket :: socket(),
+      Port :: port_number().
 
 port(Socket) ->
     case prim_inet:sockname(Socket) of
@@ -268,16 +188,18 @@ port(Socket) ->
 send(Socket, Packet) -> 
     prim_inet:send(Socket, Packet).
     
--spec setopts(Socket :: socket(), Opts :: [socket_setopt()]) -> 
-	'ok' | {'error', posix()}.
+-spec setopts(Socket, Options) -> ok | {error, posix()} when
+      Socket :: socket(),
+      Options :: [socket_setopt()].
 
 setopts(Socket, Opts) -> 
     prim_inet:setopts(Socket, Opts).
 
 -spec getopts(Socket, Options) ->
-	{'ok', [socket_setopt()]} | {'error', posix()} when
+	{'ok', OptionValues} | {'error', posix()} when
       Socket :: socket(),
-      Options :: [socket_getopt()].
+      Options :: [socket_getopt()],
+      OptionValues :: [socket_setopt()].
 
 getopts(Socket, Opts) ->
     prim_inet:getopts(Socket, Opts).
@@ -419,14 +341,19 @@ gethostname() ->
 gethostname(Socket) ->
     prim_inet:gethostname(Socket).
 
--spec getstat(Socket :: socket()) ->
-	{'ok', [{stat_option(), integer()}]} | {'error', posix()}.
+-spec getstat(Socket) ->
+	{ok, OptionValues} | {error, posix()} when
+      Socket :: socket(),
+      OptionValues :: [{stat_option(), integer()}].
 
 getstat(Socket) ->
     prim_inet:getstat(Socket, stats()).
 
--spec getstat(Socket :: socket(), Statoptions :: [stat_option()]) ->
-	{'ok', [{stat_option(), integer()}]} | {'error', posix()}.
+-spec getstat(Socket, Options) ->
+	{ok, OptionValues} | {error, posix()} when
+      Socket :: socket(),
+      Options :: [stat_option()],
+      OptionValues :: [{stat_option(), integer()}].
 
 getstat(Socket,What) ->
     prim_inet:getstat(Socket, What).
@@ -441,14 +368,14 @@ gethostbyname(Name) ->
 -spec gethostbyname(Hostname, Family) ->
                            {ok, Hostent} | {error, posix()} when
       Hostname :: hostname(),
-      Family :: family_option(),
+      Family :: address_family(),
       Hostent :: hostent().
 
 gethostbyname(Name,Family) -> 
     gethostbyname_tm(Name, Family, false).
 
 -spec gethostbyname(Name :: hostname(),
-	            Family :: family_option(),
+	            Family :: address_family(),
 	            Timeout :: non_neg_integer() | 'infinity') ->
 	{'ok', #hostent{}} | {'error', posix()}.
 	
@@ -527,14 +454,14 @@ getfd(Socket) ->
 
 -spec getaddr(Host, Family) -> {ok, Address} | {error, posix()} when
       Host :: ip_address() | hostname(),
-      Family :: family_option(),
+      Family :: address_family(),
       Address :: ip_address().
 
 getaddr(Address, Family) ->
     getaddr(Address, Family, infinity).
 
 -spec getaddr(Host :: ip_address() | hostname(),
-	      Family :: family_option(),
+	      Family :: address_family(),
 	      Timeout :: non_neg_integer() | 'infinity') ->
 	{'ok', ip_address()} | {'error', posix()}.
 
@@ -553,14 +480,14 @@ getaddr_tm(Address, Family, Timer) ->
 -spec getaddrs(Host, Family) ->
 	{ok, Addresses} | {error, posix()} when
       Host :: ip_address() | hostname(),
-      Family :: family_option(),
+      Family :: address_family(),
       Addresses :: [ip_address()].
 
 getaddrs(Address, Family) -> 
     getaddrs(Address, Family, infinity).
 
 -spec getaddrs(Host :: ip_address() | string() | atom(),
-	       Family :: family_option(),
+	       Family :: address_family(),
 	       Timeout :: non_neg_integer() | 'infinity') ->
 	{'ok', [ip_address()]} | {'error', posix()}.
 
@@ -570,7 +497,7 @@ getaddrs(Address, Family, Timeout) ->
     stop_timer(Timer),
     Res.
 
--spec getservbyport(Port :: ip_port(), Protocol :: atom() | string()) ->
+-spec getservbyport(Port :: port_number(), Protocol :: atom() | string()) ->
 	{'ok', string()} | {'error', posix()}.
 
 getservbyport(Port, Proto) ->
@@ -584,7 +511,7 @@ getservbyport(Port, Proto) ->
 
 -spec getservbyname(Name :: atom() | string(),
 	            Protocol :: atom() | string()) ->
-	{'ok', ip_port()} | {'error', posix()}.
+	{'ok', port_number()} | {'error', posix()}.
 
 getservbyname(Name, Protocol) when is_atom(Name) ->
     case inet_udp:open(0, []) of
@@ -1067,7 +994,7 @@ gethostbyaddr_tm_native(Addr, Timer, Opts) ->
 
 -spec open(Fd :: integer(),
 	   Addr :: ip_address(),
-	   Port :: ip_port(),
+	   Port :: port_number(),
 	   Opts :: [socket_setopt()],
 	   Protocol :: protocol_option(),
 	   Family :: 'inet' | 'inet6',
@@ -1108,7 +1035,7 @@ open(Fd, _Addr, _Port, Opts, Protocol, Family, Module) ->
 -spec fdopen(Fd :: non_neg_integer(),
 	     Opts :: [socket_setopt()],
 	     Protocol :: protocol_option(),
-	     Family :: family_option(),
+	     Family :: address_family(),
 	     Module :: atom()) ->
 	{'ok', socket()} | {'error', posix()}.