aboutsummaryrefslogtreecommitdiff
path: root/docs/socket.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/socket.html')
-rw-r--r--docs/socket.html29
1 files changed, 29 insertions, 0 deletions
diff --git a/docs/socket.html b/docs/socket.html
index 570f6d5..de43135 100644
--- a/docs/socket.html
+++ b/docs/socket.html
@@ -51,6 +51,14 @@ To obtain the <tt>socket</tt> namespace, run:
51local socket = require("socket") 51local socket = require("socket")
52</pre> 52</pre>
53 53
54<p>
55Two related transports are shipped as separate modules, loaded on demand
56with their own <tt>require</tt> call: <a href="unix.html">Unix domain
57sockets</a> (<tt>require("socket.unix")</tt>) and
58<a href="serial.html">serial ports</a> (<tt>require("socket.serial")</tt>).
59Both are only built on Unix-like platforms.
60</p>
61
54<!-- headers.canonic ++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 62<!-- headers.canonic ++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
55 63
56<p class="name" id="headers.canonic"> 64<p class="name" id="headers.canonic">
@@ -94,6 +102,27 @@ local headers = require("socket.headers")
94headers.setcanonic("X-Request-ID") 102headers.setcanonic("X-Request-ID")
95</pre> 103</pre>
96 104
105<!-- headers.setcanonic +++++++++++++++++++++++++++++++++++++++++++++++++ -->
106
107<p class="name" id="headers.setcanonic">
108socket.headers.<b>setcanonic(</b>name<b>)</b>
109</p>
110
111<p class="description">
112Registers a custom canonic capitalization for a header field name in
113<a href="#headers.canonic"><tt>socket.headers.canonic</tt></a>, for use
114when the automatic capitalize-first-letter-of-each-word rule would not
115reproduce it (e.g. an all-caps acronym).
116</p>
117
118<p class="parameters">
119<tt>Name</tt> is a string with the header field name in its desired
120canonic capitalization (e.g. <tt>"X-Request-ID"</tt>).
121</p>
122
123<p class="return">
124No return value.
125</p>
97 126
98<!-- bind ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 127<!-- bind ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
99 128