diff options
author | Björn-Egil Dahlberg <[email protected]> | 2012-04-16 15:04:05 +0200 |
---|---|---|
committer | Björn-Egil Dahlberg <[email protected]> | 2012-04-16 15:04:05 +0200 |
commit | f1a49c45e4b2ec746407fd777ba31fec6cab118e (patch) | |
tree | be88926165f7067bc953bf5203791241b5554801 /lib/kernel/doc/src/gen_udp.xml | |
parent | 861454268770e05bd72312c1a46560ed29a42500 (diff) | |
parent | 57c50be011a5005639d2be38f1c9f538d9f00f75 (diff) | |
download | otp-f1a49c45e4b2ec746407fd777ba31fec6cab118e.tar.gz otp-f1a49c45e4b2ec746407fd777ba31fec6cab118e.tar.bz2 otp-f1a49c45e4b2ec746407fd777ba31fec6cab118e.zip |
Merge branch 'egil/inet-document-options/OTP-10053' into maint
* egil/inet-document-options/OTP-10053:
kernel: Document ifaddr option
kernel: Document tcp-, udp- and sctp_module option
kernel: Remove bit8 option in spec
kernel: Document bit8 option in inet:setopts/2
kernel: Initial doc of forgotten inet options
Diffstat (limited to 'lib/kernel/doc/src/gen_udp.xml')
-rw-r--r-- | lib/kernel/doc/src/gen_udp.xml | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/lib/kernel/doc/src/gen_udp.xml b/lib/kernel/doc/src/gen_udp.xml index daa9b7d887..77e6182884 100644 --- a/lib/kernel/doc/src/gen_udp.xml +++ b/lib/kernel/doc/src/gen_udp.xml @@ -72,6 +72,14 @@ <p>If the host has several network interfaces, this option specifies which one to use.</p> </item> + + <tag><c>{ifaddr, ip_address()}</c></tag> + <item> + <p>Same as <c>{ip, ip_address()}</c>. If the host has several network interfaces, this option + specifies which one to use.</p> + </item> + + <tag><c>{fd, integer() >= 0}</c></tag> <item> <p>If a socket has somehow been opened without using @@ -86,6 +94,51 @@ <item> <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> + </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 |