diff options
Diffstat (limited to 'doc/tcp.html')
| -rw-r--r-- | doc/tcp.html | 95 |
1 files changed, 94 insertions, 1 deletions
diff --git a/doc/tcp.html b/doc/tcp.html index d1d2154..f59d7ac 100644 --- a/doc/tcp.html +++ b/doc/tcp.html | |||
| @@ -397,7 +397,40 @@ disables the Nagle's algorithm for the connection. | |||
| 397 | </ul> | 397 | </ul> |
| 398 | 398 | ||
| 399 | <p class=return> | 399 | <p class=return> |
| 400 | The method returns 1 in case of success, or <b><tt>nil</tt></b> otherwise. | 400 | The method returns 1 in case of success, or <b><tt>nil</tt></b> |
| 401 | followed by an error message otherwise. | ||
| 402 | </p> | ||
| 403 | |||
| 404 | <p class=note> | ||
| 405 | Note: The descriptions above come from the man pages. | ||
| 406 | </p> | ||
| 407 | |||
| 408 | <!-- getoption ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 409 | |||
| 410 | <p class=name id=getoption> | ||
| 411 | client:<b>getoption(</b>option)</b><br> | ||
| 412 | server:<b>getoption(</b>option)</b> | ||
| 413 | </p> | ||
| 414 | |||
| 415 | <p class=description> | ||
| 416 | Gets options for the TCP object. | ||
| 417 | See <a href=#setoption><tt>setoption</tt></a> for description of the | ||
| 418 | option names and values. | ||
| 419 | </p> | ||
| 420 | |||
| 421 | <p class=parameters> | ||
| 422 | <tt>Option</tt> is a string with the option name. | ||
| 423 | <ul> | ||
| 424 | |||
| 425 | <li> '<tt>keepalive</tt>' | ||
| 426 | <li> '<tt>linger</tt>' | ||
| 427 | <li> '<tt>reuseaddr</tt>' | ||
| 428 | <li> '<tt>tcp-nodelay</tt>' | ||
| 429 | </ul> | ||
| 430 | |||
| 431 | <p class=return> | ||
| 432 | The method returns the option <tt>value</tt> in case of success, or | ||
| 433 | <b><tt>nil</tt></b> followed by an error message otherwise. | ||
| 401 | </p> | 434 | </p> |
| 402 | 435 | ||
| 403 | <p class=note> | 436 | <p class=note> |
| @@ -508,6 +541,66 @@ This is the default mode; | |||
| 508 | This function returns 1. | 541 | This function returns 1. |
| 509 | </p> | 542 | </p> |
| 510 | 543 | ||
| 544 | <!-- dirty +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 545 | |||
| 546 | <p class=name id=dirty> | ||
| 547 | master:<b>dirty()</b><br> | ||
| 548 | client:<b>dirty()</b><br> | ||
| 549 | server:<b>dirty()</b> | ||
| 550 | </p> | ||
| 551 | |||
| 552 | <p class=description> | ||
| 553 | Check the read buffer status. | ||
| 554 | </p> | ||
| 555 | |||
| 556 | <p class=return> | ||
| 557 | Returns <tt>true</tt> if there is any data in the read buffer, <tt>false</tt> otherwise. | ||
| 558 | </p> | ||
| 559 | |||
| 560 | <p class=note> | ||
| 561 | Note: <b>This is an internal method, any use is unlikely to be portable.</b> | ||
| 562 | </p> | ||
| 563 | |||
| 564 | <!-- getfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 565 | |||
| 566 | <p class=name id=getfd> | ||
| 567 | master:<b>getfd()</b><br> | ||
| 568 | client:<b>getfd()</b><br> | ||
| 569 | server:<b>getfd()</b> | ||
| 570 | </p> | ||
| 571 | |||
| 572 | <p class=description> | ||
| 573 | Returns the underling socket descriptor or handle associated to the object. | ||
| 574 | </p> | ||
| 575 | |||
| 576 | <p class=return> | ||
| 577 | The descriptor or handle. In case the object has been closed, the return will be -1. | ||
| 578 | </p> | ||
| 579 | |||
| 580 | <p class=note> | ||
| 581 | Note: <b>This is an internal method, any use is unlikely to be portable.</b> | ||
| 582 | </p> | ||
| 583 | |||
| 584 | <!-- setfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 585 | |||
| 586 | <p class=name id=setfd> | ||
| 587 | master:<b>setfd(</b>fd<b>)</b><br> | ||
| 588 | client:<b>setfd(</b>fd<b>)</b><br> | ||
| 589 | server:<b>setfd(</b>fd<b>)</b> | ||
| 590 | </p> | ||
| 591 | |||
| 592 | <p class=description> | ||
| 593 | Sets the underling socket descriptor or handle associated to the object. The current one is simply replaced, not closed, and no other change to the object state is made. | ||
| 594 | </p> | ||
| 595 | |||
| 596 | <p class=return> | ||
| 597 | No return value. | ||
| 598 | </p> | ||
| 599 | |||
| 600 | <p class=note> | ||
| 601 | Note: <b>This is an internal method, any use is unlikely to be portable.</b> | ||
| 602 | </p> | ||
| 603 | |||
| 511 | <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 604 | <!-- footer +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 512 | 605 | ||
| 513 | <div class=footer> | 606 | <div class=footer> |
