diff options
| author | Björn-Egil Dahlberg <[email protected]> | 2012-04-12 15:36:59 +0200 |
|---|---|---|
| committer | Björn-Egil Dahlberg <[email protected]> | 2012-04-12 15:36:59 +0200 |
| commit | 14867ef618386d5008adf19b8d7a76e56f869145 (patch) | |
| tree | cf596df215f769aaa93953184a1b37622af479de /lib/kernel/doc/src/gen_tcp.xml | |
| parent | 5573888eea1ff6e3e169a6c873c2f5ada81eab62 (diff) | |
| download | otp-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_tcp.xml')
| -rw-r--r-- | lib/kernel/doc/src/gen_tcp.xml | 37 |
1 files changed, 21 insertions, 16 deletions
diff --git a/lib/kernel/doc/src/gen_tcp.xml b/lib/kernel/doc/src/gen_tcp.xml index cf97607af1..32a0f9b0d7 100644 --- a/lib/kernel/doc/src/gen_tcp.xml +++ b/lib/kernel/doc/src/gen_tcp.xml @@ -96,37 +96,42 @@ do_recv(Sock, Bs) -> can be either a hostname, or an IP address.</p> <p>The available options are:</p> <taglist> - <tag><c>list</c></tag> - <item> - <p>Received <c>Packet</c> is delivered as a list.</p> - </item> - <tag><c>binary</c></tag> - <item> - <p>Received <c>Packet</c> is delivered as a binary.</p> - </item> - <tag><c>{ip, ip_address()}</c></tag> + <tag><c>{ip, ip_address()}</c></tag> <item> <p>If the host has several network interfaces, this option specifies which one to use.</p> </item> - <tag><c>{port, Port}</c></tag> - <item> - <p>Specify which local port number to use.</p> - </item> + <tag><c>{fd, integer() >= 0}</c></tag> <item> <p>If a socket has somehow been connected without using <c>gen_tcp</c>, use this option to pass the file descriptor for it.</p> </item> - <tag><c>inet6</c></tag> + + <tag><c>{ifaddr, ip_address()}</c></tag> + <item> <p>TODO: Document</p> + </item> + + <tag><c>inet</c></tag> <item> + <p>Set up the socket for IPv4.</p> + </item> + + <tag><c>inet6</c></tag> + <item> <p>Set up the socket for IPv6.</p> </item> - <tag><c>inet</c></tag> + + <tag><c>{port, Port}</c></tag> <item> - <p>Set up the socket for IPv4.</p> + <p>Specify which local port number to use.</p> </item> + + <tag><c>{tcp_module, module()}</c></tag> + <item> <p>TODO: Document</p> + </item> + <tag><c>Opt</c></tag> <item> <p>See |