diff options
Diffstat (limited to 'docs/tcp.html')
| -rw-r--r-- | docs/tcp.html | 31 |
1 files changed, 30 insertions, 1 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"> |
