aboutsummaryrefslogtreecommitdiffstats
path: root/lib/kernel/doc/src/gen_udp.xml
diff options
context:
space:
mode:
authorBjörn-Egil Dahlberg <[email protected]>2012-04-12 15:36:59 +0200
committerBjörn-Egil Dahlberg <[email protected]>2012-04-12 15:36:59 +0200
commit14867ef618386d5008adf19b8d7a76e56f869145 (patch)
treecf596df215f769aaa93953184a1b37622af479de /lib/kernel/doc/src/gen_udp.xml
parent5573888eea1ff6e3e169a6c873c2f5ada81eab62 (diff)
downloadotp-14867ef618386d5008adf19b8d7a76e56f869145.tar.gz
otp-14867ef618386d5008adf19b8d7a76e56f869145.tar.bz2
otp-14867ef618386d5008adf19b8d7a76e56f869145.zip
kernel: Initial doc of forgotten inet options
* UDP: ulticast_if, multicast_loop and multicast_ttl, add_membership and drop_membership * Inet: bit8, buffer, deliver, high_watermark, linger and low_watermark
Diffstat (limited to 'lib/kernel/doc/src/gen_udp.xml')
-rw-r--r--lib/kernel/doc/src/gen_udp.xml38
1 files changed, 38 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml
index daa9b7d887..0b2cd3d765 100644
--- a/lib/kernel/doc/src/gen_udp.xml
+++ b/lib/kernel/doc/src/gen_udp.xml
@@ -86,6 +86,44 @@
<item>
<p>Set up the socket for IPv4.</p>
</item>
+
+ <tag><c>{multicast_if, Address}</c></tag>
+ <item>
+ <p>Set the local device for a multicast socket.</p>
+ </item>
+
+ <tag><c>{multicast_loop, true | false}</c></tag>
+ <item>
+ <p>
+ When <c>true</c> sent multicast packets will be looped back to the local
+ sockets.
+ </p>
+ </item>
+
+ <tag><c>{multicast_ttl, Integer}</c></tag>
+ <item>
+ <p>
+ The <c>multicast_ttl</c> option changes the time-to-live (TTL) for
+ outgoing multicast datagrams in order to control the scope of the
+ multicasts.
+ </p>
+ <p>
+ Datagrams with a TTL of 1 are not forwarded beyond the local
+ network.
+ <br />Default: 1
+ </p>
+ </item>
+
+ <tag><c>{add_membership, {MultiAddress, InterfaceAddress}}</c></tag>
+ <item>
+ <p>Join a multicast group. </p>
+ </item>
+
+ <tag><c>{drop_membership, {MultiAddress, InterfaceAddress}}</c></tag>
+ <item>
+ <p>Leave multicast group.</p>
+ </item>
+
<tag><c>Opt</c></tag>
<item>
<p>See