From d64479bcc536c64b15e0c9fa28ecb73bc7e385a4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn-Egil=20Dahlberg?= Date: Fri, 13 Apr 2012 15:17:47 +0200 Subject: kernel: Document tcp-, udp- and sctp_module option --- lib/kernel/doc/src/gen_sctp.xml | 9 +++++++++ lib/kernel/doc/src/gen_tcp.xml | 18 +++++++++++++++++- lib/kernel/doc/src/gen_udp.xml | 7 +++++++ 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/lib/kernel/doc/src/gen_sctp.xml b/lib/kernel/doc/src/gen_sctp.xml index 291aee62b1..cf1cfb6ec9 100644 --- a/lib/kernel/doc/src/gen_sctp.xml +++ b/lib/kernel/doc/src/gen_sctp.xml @@ -571,6 +571,15 @@ val(sndbuf). Setting this option also adjusts the size of the driver buffer (see buffer above).

+ + {sctp_module, module()} +

+ Override which callback module used. Defaults to + inet_sctp for IPv4 and inet6_sctp for IPv6. +

+
+ + {sctp_rtoinfo, #sctp_rtoinfo{}}
  #sctp_rtoinfo{
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml
index 32a0f9b0d7..e4f1cf7612 100644
--- a/lib/kernel/doc/src/gen_tcp.xml
+++ b/lib/kernel/doc/src/gen_tcp.xml
@@ -129,7 +129,10 @@ do_recv(Sock, Bs) ->
           
 
 		  {tcp_module, module()}
-           

TODO: Document

+

+ Override which callback module used. Defaults to + inet_tcp for IPv4 and inet6_tcp for IPv6. +

Opt @@ -202,6 +205,11 @@ do_recv(Sock, Bs) -> gen_tcp, use this option to pass the file descriptor for it.

+ + {ifaddr, ip_address()} +

TODO: Document

+
+ inet6

Set up the socket for IPv6.

@@ -210,6 +218,14 @@ do_recv(Sock, Bs) ->

Set up the socket for IPv4.

+ + {tcp_module, module()} +

+ Override which callback module used. Defaults to + inet_tcp for IPv4 and inet6_tcp for IPv6. +

+
+ Opt

See diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml index 0b2cd3d765..7cf8a6da4c 100644 --- a/lib/kernel/doc/src/gen_udp.xml +++ b/lib/kernel/doc/src/gen_udp.xml @@ -87,6 +87,13 @@

Set up the socket for IPv4.

+ {udp_module, module()} +

+ Override which callback module used. Defaults to + inet_udp for IPv4 and inet6_udp for IPv6. +

+
+ {multicast_if, Address}

Set the local device for a multicast socket.

-- cgit v1.2.3