diff options
| author | Thijs Schreijer <thijs@thijsschreijer.nl> | 2026-09-01 10:00:21 +0200 |
|---|---|---|
| committer | Thijs Schreijer <thijs@thijsschreijer.nl> | 2026-09-01 10:48:40 +0200 |
| commit | 70f7800986812ad0d1a5dd6f280f66fd2bf1dd12 (patch) | |
| tree | 36051874b3ce036307d4bb69b3c4058458b6255d /docs/tcp.html | |
| parent | fa9b35a0cf11bc856cbd8bffbef5ad6fb3e62a93 (diff) | |
| download | luasocket-docs/pre-release-audit.tar.gz luasocket-docs/pre-release-audit.tar.bz2 luasocket-docs/pre-release-audit.zip | |
docs: document socket.unix and socket.serial, fix stale/missing API referencesdocs/pre-release-audit
Pre-release documentation audit against master. Adds the two fully
undocumented modules and closes gaps found by diffing every docs/*.html
page against its corresponding source:
- New docs/unix.html and docs/serial.html (socket.unix stream/dgram and
socket.serial were never documented), linked from index.html,
introduction.html, socket.html and reference.html. serial.html notes
the current lack of a baud/parity/flow-control API and includes an
os.execute+stty workaround example. Both note Windows is unsupported.
- socket.html: document headers.setcanonic, point to unix/serial modules.
- tcp.html: document getfamily, setpeername/setsockname aliases.
- udp.html: document getfamily, getfd/setfd, dirty; document the
ipv6-multicast-hops/ipv6-unicast-hops aliasing as current (known-buggy)
behavior rather than the originally intended semantics.
- http.html: correct redirect text (301/302/303/307/308, was 301/302
only); document MAXHEADERLINE/MAXHEADERSIZE.
- dns.html: document getnameinfo.
- ltn12.html: document source.rewind and BLOCKSIZE.
- installation.html: fix stale "LuaSocket 3.0" sample output to 3.1.0.
- reference.html: index every anchor added above plus new Unix/Serial
blocks.
Diffstat (limited to 'docs/tcp.html')
| -rw-r--r-- | docs/tcp.html | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/tcp.html b/docs/tcp.html index 715d28f..580bdcf 100644 --- a/docs/tcp.html +++ b/docs/tcp.html | |||
| @@ -196,6 +196,25 @@ Note: <b>This is an internal method, use at your own risk.</b> | |||
| 196 | </p> | 196 | </p> |
| 197 | 197 | ||
| 198 | 198 | ||
| 199 | <!-- getfamily +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 200 | |||
| 201 | <p class="name" id="getfamily"> | ||
| 202 | master:<b>getfamily()</b><br> | ||
| 203 | client:<b>getfamily()</b><br> | ||
| 204 | server:<b>getfamily()</b> | ||
| 205 | </p> | ||
| 206 | |||
| 207 | <p class="description"> | ||
| 208 | Returns the family of the underlying socket, as chosen when the object was | ||
| 209 | created by <a href="socket.html#connect"><tt>socket.tcp</tt></a>, | ||
| 210 | <a href="#socket.tcp4"><tt>socket.tcp4</tt></a> or | ||
| 211 | <a href="#socket.tcp6"><tt>socket.tcp6</tt></a>. | ||
| 212 | </p> | ||
| 213 | |||
| 214 | <p class="return"> | ||
| 215 | The string "<tt>inet4</tt>" or "<tt>inet6</tt>". | ||
| 216 | </p> | ||
| 217 | |||
| 199 | <!-- getfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 218 | <!-- getfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 200 | 219 | ||
| 201 | <p class="name" id="getfd"> | 220 | <p class="name" id="getfd"> |
| @@ -651,6 +670,30 @@ This is the default mode;</li> | |||
| 651 | This function returns 1. | 670 | This function returns 1. |
| 652 | </p> | 671 | </p> |
| 653 | 672 | ||
| 673 | <!-- setpeername +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 674 | |||
| 675 | <p class="name" id="setpeername"> | ||
| 676 | master:<b>setpeername(</b>address, port<b>)</b> | ||
| 677 | </p> | ||
| 678 | |||
| 679 | <p class="description"> | ||
| 680 | Alias for <a href="#connect"><tt>connect</tt></a>, kept for naming symmetry | ||
| 681 | with <a href="udp.html#setpeername"><tt>udp:setpeername</tt></a> and with | ||
| 682 | <a href="#getpeername"><tt>getpeername</tt></a>. | ||
| 683 | </p> | ||
| 684 | |||
| 685 | <!-- setsockname +++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | ||
| 686 | |||
| 687 | <p class="name" id="setsockname"> | ||
| 688 | master:<b>setsockname(</b>address, port<b>)</b> | ||
| 689 | </p> | ||
| 690 | |||
| 691 | <p class="description"> | ||
| 692 | Alias for <a href="#bind"><tt>bind</tt></a>, kept for naming symmetry | ||
| 693 | with <a href="udp.html#setsockname"><tt>udp:setsockname</tt></a> and with | ||
| 694 | <a href="#getsockname"><tt>getsockname</tt></a>. | ||
| 695 | </p> | ||
| 696 | |||
| 654 | <!-- setfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> | 697 | <!-- setfd +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> |
| 655 | 698 | ||
| 656 | <p class="name" id="setfd"> | 699 | <p class="name" id="setfd"> |
