diff options
| author | Björn-Egil Dahlberg <[email protected]> | 2012-04-13 15:17:47 +0200 |
|---|---|---|
| committer | Björn-Egil Dahlberg <[email protected]> | 2012-04-16 15:03:35 +0200 |
| commit | d64479bcc536c64b15e0c9fa28ecb73bc7e385a4 (patch) | |
| tree | 4c21bd1758c7f36610d1a9e44ec1d08cf7eb6a94 | |
| parent | 50feb4016f66d3c31eadf53d46987cac57819639 (diff) | |
| download | otp-d64479bcc536c64b15e0c9fa28ecb73bc7e385a4.tar.gz otp-d64479bcc536c64b15e0c9fa28ecb73bc7e385a4.tar.bz2 otp-d64479bcc536c64b15e0c9fa28ecb73bc7e385a4.zip | |
kernel: Document tcp-, udp- and sctp_module option
| -rw-r--r-- | lib/kernel/doc/src/gen_sctp.xml | 9 | ||||
| -rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 18 | ||||
| -rw-r--r-- | lib/kernel/doc/src/gen_udp.xml | 7 |
3 files changed, 33 insertions, 1 deletions
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 @@ <c>val(sndbuf)</c>. Setting this option also adjusts the size of the driver buffer (see <c>buffer</c> above).</p> </item> + + <tag><c>{sctp_module, module()}</c></tag> + <item> <p> + Override which callback module used. Defaults to + <c>inet_sctp</c> for IPv4 and <c>inet6_sctp</c> for IPv6. + </p> + </item> + + <tag><c>{sctp_rtoinfo, #sctp_rtoinfo{}}</c></tag> <item> <pre> #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) -> </item> <tag><c>{tcp_module, module()}</c></tag> - <item> <p>TODO: Document</p> + <item> <p> + Override which callback module used. Defaults to + <c>inet_tcp</c> for IPv4 and <c>inet6_tcp</c> for IPv6. + </p> </item> <tag><c>Opt</c></tag> @@ -202,6 +205,11 @@ do_recv(Sock, Bs) -> <c>gen_tcp</c>, use this option to pass the file descriptor for it.</p> </item> + + <tag><c>{ifaddr, ip_address()}</c></tag> + <item> <p>TODO: Document</p> + </item> + <tag><c>inet6</c></tag> <item> <p>Set up the socket for IPv6.</p> @@ -210,6 +218,14 @@ do_recv(Sock, Bs) -> <item> <p>Set up the socket for IPv4.</p> </item> + + <tag><c>{tcp_module, module()}</c></tag> + <item> <p> + Override which callback module used. Defaults to + <c>inet_tcp</c> for IPv4 and <c>inet6_tcp</c> for IPv6. + </p> + </item> + <tag><c>Opt</c></tag> <item> <p>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 @@ <p>Set up the socket for IPv4.</p> </item> + <tag><c>{udp_module, module()}</c></tag> + <item> <p> + Override which callback module used. Defaults to + <c>inet_udp</c> for IPv4 and <c>inet6_udp</c> for IPv6. + </p> + </item> + <tag><c>{multicast_if, Address}</c></tag> <item> <p>Set the local device for a multicast socket.</p> |