diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/tcp.html | 31 | ||||
| -rw-r--r-- | docs/udp.html | 45 |
2 files changed, 71 insertions, 5 deletions
diff --git a/docs/tcp.html b/docs/tcp.html index a26228d..d223abf 100644 --- a/docs/tcp.html +++ b/docs/tcp.html | |||
| @@ -236,10 +236,20 @@ option names and values. | |||
| 236 | <p class="parameters"> | 236 | <p class="parameters"> |
| 237 | <tt>Option</tt> is a string with the option name.</p> | 237 | <tt>Option</tt> is a string with the option name.</p> |
| 238 | <ul> | 238 | <ul> |
| 239 | <li> '<tt>bindtodevice</tt>'</li> | ||
| 239 | <li> '<tt>keepalive</tt>'</li> | 240 | <li> '<tt>keepalive</tt>'</li> |
| 240 | <li> '<tt>linger</tt>'</li> | ||
| 241 | <li> '<tt>reuseaddr</tt>'</li> | 241 | <li> '<tt>reuseaddr</tt>'</li> |
| 242 | <li> '<tt>exclusiveaddruse</tt>'</li> | ||
| 243 | <li> '<tt>reuseport</tt>'</li> | ||
| 242 | <li> '<tt>tcp-nodelay</tt>'</li> | 244 | <li> '<tt>tcp-nodelay</tt>'</li> |
| 245 | <li> '<tt>tcp-keepidle</tt>'</li> | ||
| 246 | <li> '<tt>tcp-keepcnt</tt>'</li> | ||
| 247 | <li> '<tt>tcp-keepintvl</tt>'</li> | ||
| 248 | <li> '<tt>linger</tt>'</li> | ||
| 249 | <li> '<tt>error</tt>': Returns the socket's pending error status, if | ||
| 250 | any, and clears it. Get-only.</li> | ||
| 251 | <li> '<tt>recv-buffer-size</tt>'</li> | ||
| 252 | <li> '<tt>send-buffer-size</tt>'</li> | ||
| 243 | </ul> | 253 | </ul> |
| 244 | 254 | ||
| 245 | <p class="return"> | 255 | <p class="return"> |
| @@ -456,6 +466,11 @@ depends on the option being set:</p> | |||
| 456 | 466 | ||
| 457 | <ul> | 467 | <ul> |
| 458 | 468 | ||
| 469 | <li> '<tt>bindtodevice</tt>': Binds the socket to a specific network | ||
| 470 | interface, given its name (e.g. <tt>"eth0"</tt>), so that only packets | ||
| 471 | received on that interface are processed. Receives a string. Linux | ||
| 472 | only!!</li> | ||
| 473 | |||
| 459 | <li> '<tt>keepalive</tt>': Setting this option to <tt>true</tt> enables | 474 | <li> '<tt>keepalive</tt>': Setting this option to <tt>true</tt> enables |
| 460 | the periodic transmission of messages on a connected socket. Should the | 475 | the periodic transmission of messages on a connected socket. Should the |
| 461 | connected party fail to respond to these messages, the connection is | 476 | connected party fail to respond to these messages, the connection is |
| @@ -476,6 +491,14 @@ zero;</li> | |||
| 476 | used in validating addresses supplied in a call to | 491 | used in validating addresses supplied in a call to |
| 477 | <a href="#bind"><tt>bind</tt></a> should allow reuse of local addresses;</li> | 492 | <a href="#bind"><tt>bind</tt></a> should allow reuse of local addresses;</li> |
| 478 | 493 | ||
| 494 | <li> '<tt>exclusiveaddruse</tt>': Setting this option to <tt>true</tt> | ||
| 495 | prevents other sockets from binding to the same address and port, even if | ||
| 496 | those sockets set '<tt>reuseaddr</tt>'. Windows only!!</li> | ||
| 497 | |||
| 498 | <li> '<tt>reuseport</tt>': Allows completely duplicate bindings by | ||
| 499 | multiple processes if they all set '<tt>reuseport</tt>' before binding | ||
| 500 | the port.</li> | ||
| 501 | |||
| 479 | <li> '<tt>tcp-nodelay</tt>': Setting this option to <tt>true</tt> | 502 | <li> '<tt>tcp-nodelay</tt>': Setting this option to <tt>true</tt> |
| 480 | disables the Nagle's algorithm for the connection;</li> | 503 | disables the Nagle's algorithm for the connection;</li> |
| 481 | 504 | ||
| @@ -494,6 +517,12 @@ disables the Nagle's algorithm for the connection;</li> | |||
| 494 | <li> '<tt>ipv6-v6only</tt>': | 517 | <li> '<tt>ipv6-v6only</tt>': |
| 495 | Setting this option to <tt>true</tt> restricts an <tt>inet6</tt> socket to | 518 | Setting this option to <tt>true</tt> restricts an <tt>inet6</tt> socket to |
| 496 | sending and receiving only IPv6 packets.</li> | 519 | sending and receiving only IPv6 packets.</li> |
| 520 | |||
| 521 | <li> '<tt>recv-buffer-size</tt>': Sets the size, in bytes, of the | ||
| 522 | socket's receive buffer (<tt>SO_RCVBUF</tt>). Receives a number.</li> | ||
| 523 | |||
| 524 | <li> '<tt>send-buffer-size</tt>': Sets the size, in bytes, of the | ||
| 525 | socket's send buffer (<tt>SO_SNDBUF</tt>). Receives a number.</li> | ||
| 497 | </ul> | 526 | </ul> |
| 498 | 527 | ||
| 499 | <p class="return"> | 528 | <p class="return"> |
diff --git a/docs/udp.html b/docs/udp.html index 99613b8..8d807a4 100644 --- a/docs/udp.html +++ b/docs/udp.html | |||
| @@ -80,13 +80,18 @@ description of the option names and values. | |||
| 80 | <li> '<tt>dontroute</tt>'</li> | 80 | <li> '<tt>dontroute</tt>'</li> |
| 81 | <li> '<tt>broadcast</tt>'</li> | 81 | <li> '<tt>broadcast</tt>'</li> |
| 82 | <li> '<tt>reuseaddr</tt>'</li> | 82 | <li> '<tt>reuseaddr</tt>'</li> |
| 83 | <li> '<tt>exclusiveaddruse</tt>'</li> | ||
| 83 | <li> '<tt>reuseport</tt>'</li> | 84 | <li> '<tt>reuseport</tt>'</li> |
| 84 | <li> '<tt>ip-multicast-loop</tt>'</li> | 85 | <li> '<tt>ip-multicast-loop</tt>'</li> |
| 85 | <li> '<tt>ipv6-v6only</tt>'</li> | 86 | <li> '<tt>ipv6-v6only</tt>'</li> |
| 87 | <li> '<tt>ipv6-unicast-hops</tt>'</li> | ||
| 88 | <li> '<tt>ipv6-multicast-hops</tt>'</li> | ||
| 89 | <li> '<tt>ipv6-multicast-loop</tt>'</li> | ||
| 86 | <li> '<tt>ip-multicast-if</tt>'</li> | 90 | <li> '<tt>ip-multicast-if</tt>'</li> |
| 87 | <li> '<tt>ip-multicast-ttl</tt>'</li> | 91 | <li> '<tt>error</tt>': Returns the socket's pending error status, if |
| 88 | <li> '<tt>ip-add-membership</tt>'</li> | 92 | any, and clears it. Get-only.</li> |
| 89 | <li> '<tt>ip-drop-membership</tt>'</li> | 93 | <li> '<tt>recv-buffer-size</tt>'</li> |
| 94 | <li> '<tt>send-buffer-size</tt>'</li> | ||
| 90 | </ul> | 95 | </ul> |
| 91 | </p> | 96 | </p> |
| 92 | 97 | ||
| @@ -294,6 +299,10 @@ Receives a boolean value;</li> | |||
| 294 | validating addresses supplied in a <tt>bind()</tt> call | 299 | validating addresses supplied in a <tt>bind()</tt> call |
| 295 | should allow reuse of local addresses. | 300 | should allow reuse of local addresses. |
| 296 | Receives a boolean value;</li> | 301 | Receives a boolean value;</li> |
| 302 | <li> '<tt>exclusiveaddruse</tt>': Setting this option to <tt>true</tt> | ||
| 303 | prevents other sockets from binding to the same address and port, even | ||
| 304 | if those sockets set '<tt>reuseaddr</tt>'. | ||
| 305 | Receives a boolean value. Windows only!!</li> | ||
| 297 | <li> '<tt>reuseport</tt>': Allows completely duplicate | 306 | <li> '<tt>reuseport</tt>': Allows completely duplicate |
| 298 | bindings by multiple processes if they all set | 307 | bindings by multiple processes if they all set |
| 299 | '<tt>reuseport</tt>' before binding the port. | 308 | '<tt>reuseport</tt>' before binding the port. |
| @@ -307,6 +316,28 @@ Receives a boolean value;</li> | |||
| 307 | Specifies whether to restrict <tt>inet6</tt> sockets to | 316 | Specifies whether to restrict <tt>inet6</tt> sockets to |
| 308 | sending and receiving only IPv6 packets. | 317 | sending and receiving only IPv6 packets. |
| 309 | Receive a boolean value;</li> | 318 | Receive a boolean value;</li> |
| 319 | <li> '<tt>ipv6-unicast-hops</tt>': | ||
| 320 | Sets the unicast hop limit (the IPv6 equivalent of the IPv4 TTL) | ||
| 321 | for outgoing packets. | ||
| 322 | Receives a number;</li> | ||
| 323 | <li> '<tt>ipv6-multicast-hops</tt>': | ||
| 324 | Sets the hop limit for outgoing IPv6 multicast datagrams. | ||
| 325 | Receives a number;</li> | ||
| 326 | <li> '<tt>ipv6-multicast-loop</tt>': | ||
| 327 | Specifies whether or not a copy of an outgoing IPv6 multicast | ||
| 328 | datagram is delivered to the sending host as long as it is a | ||
| 329 | member of the multicast group. | ||
| 330 | Receives a boolean value;</li> | ||
| 331 | <li> '<tt>ipv6-add-membership</tt>': | ||
| 332 | Joins the IPv6 multicast group specified. | ||
| 333 | Receives a table with field | ||
| 334 | <tt>multiaddr</tt>, an IPv6 address, and optionally | ||
| 335 | <tt>interface</tt>, a network interface index number;</li> | ||
| 336 | <li> '<tt>ipv6-drop-membership</tt>': Leaves the IPv6 multicast | ||
| 337 | group specified. | ||
| 338 | Receives a table with field | ||
| 339 | <tt>multiaddr</tt>, an IPv6 address, and optionally | ||
| 340 | <tt>interface</tt>, a network interface index number;</li> | ||
| 310 | <li> '<tt>ip-multicast-if</tt>': | 341 | <li> '<tt>ip-multicast-if</tt>': |
| 311 | Sets the interface over which outgoing multicast datagrams | 342 | Sets the interface over which outgoing multicast datagrams |
| 312 | are sent. | 343 | are sent. |
| @@ -324,7 +355,13 @@ IP address;</li> | |||
| 324 | group specified. | 355 | group specified. |
| 325 | Receives a table with fields | 356 | Receives a table with fields |
| 326 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an | 357 | <tt>multiaddr</tt> and <tt>interface</tt>, each containing an |
| 327 | IP address.</li> | 358 | IP address;</li> |
| 359 | <li> '<tt>recv-buffer-size</tt>': Sets the size, in bytes, of the | ||
| 360 | socket's receive buffer (<tt>SO_RCVBUF</tt>). | ||
| 361 | Receives a number;</li> | ||
| 362 | <li> '<tt>send-buffer-size</tt>': Sets the size, in bytes, of the | ||
| 363 | socket's send buffer (<tt>SO_SNDBUF</tt>). | ||
| 364 | Receives a number.</li> | ||
| 328 | </ul> | 365 | </ul> |
| 329 | 366 | ||
| 330 | <p class="return"> | 367 | <p class="return"> |
