aboutsummaryrefslogtreecommitdiff
path: root/doc/reference.html
diff options
context:
space:
mode:
authorDiego Nehab <diego@tecgraf.puc-rio.br>2004-01-24 02:47:24 +0000
committerDiego Nehab <diego@tecgraf.puc-rio.br>2004-01-24 02:47:24 +0000
commit62a4c505e488c714e8795ea85564504562d30301 (patch)
treef270f53f26905b7275cea172e52ebc269a41c695 /doc/reference.html
parent0c9f420a3549df3fb331bb24157b65a3301641d4 (diff)
downloadluasocket-62a4c505e488c714e8795ea85564504562d30301.tar.gz
luasocket-62a4c505e488c714e8795ea85564504562d30301.tar.bz2
luasocket-62a4c505e488c714e8795ea85564504562d30301.zip
Working on the manual...
Making better tests for error messages. Changed a few names. Moved gethostname to inet.c.
Diffstat (limited to 'doc/reference.html')
-rw-r--r--doc/reference.html298
1 files changed, 158 insertions, 140 deletions
diff --git a/doc/reference.html b/doc/reference.html
index 99b1ea7..0bfd378 100644
--- a/doc/reference.html
+++ b/doc/reference.html
@@ -35,155 +35,173 @@
35 35
36<h2>Reference</h2> 36<h2>Reference</h2>
37 37
38<!-- tcp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 38<!-- callback +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
39 39
40<table summary="TCP Index" class=index width=100%> 40<blockquote>
41<colgroup> <col width="50%"> <col width="50%"> </colgroup> 41<a href="callback.html">Callbacks (socket.callback)</a>
42<tr> 42<blockquote>
43<td><ul> 43<a href="callback.html#send">send</a>:
44<li><a href="tcp.html">TCP (socket.tcp)</a> 44<a href="callback.html#send.chain">chain</a>,
45 <ul> 45<a href="callback.html#send.file">file</a>,
46 <li><a href="tcp.html#accept">accept</a> 46<a href="callback.html#send.string">string</a>.
47 <li><a href="tcp.html#bind">bind</a> 47</blockquote>
48 <li><a href="tcp.html#close">close</a> 48<blockquote>
49 <li><a href="tcp.html#connect">connect</a> 49<a href="callback.html#receive">receive</a>:
50 <li><a href="tcp.html#getpeername">getpeername</a> 50<a href="callback.html#receive.chain">chain</a>,
51 </ul> 51<a href="callback.html#receive.file">file</a>,
52</ul></td> 52<a href="callback.html#receive.concat">concat</a>.
53<td valign=top><ul> 53</blockquote>
54 <li><a href="tcp.html#getsockname">getsockname</a> 54</blockquote>
55 <li><a href="tcp.html#receive">receive</a>
56 <li><a href="tcp.html#send">send</a>
57 <li><a href="tcp.html#setoption">setoption</a>
58 <li><a href="tcp.html#settimeout">settimeout</a>
59</ul></td>
60</tr>
61</table> 55</table>
62 56
63<hr> 57<!-- dns ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
64 58
65<!-- udp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 59<blockquote>
66 60<a href="dns.html">DNS services (socket.dns)</a>
67<table summary="UDP Index" class=index width=100%> 61<blockquote>
68<colgroup> <col width="50%"> <col width="50%"> </colgroup> 62<a href="dns.html#toip">toip</a>,
69<tr> 63<a href="dns.html#tohostname">tohostname</a>,
70<td><ul> 64<a href="dns.html#gethostname">gethostname</a>.
71<li><a href="udp.html">UDP (socket.udp)</a> 65</blockquote>
72 <ul> 66</blockquote>
73 <li><a href="udp.html#close">close</a> 67
74 <li><a href="udp.html#getpeername">getpeername</a> 68<!-- ftp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
75 <li><a href="udp.html#getsockname">getsockname</a> 69
76 <li><a href="udp.html#receive">receive</a> 70<blockquote>
77 <li><a href="udp.html#receivefrom">receivefrom</a> 71<a href="ftp.html">FTP (socket.ftp)</a>
78 </ul> 72<blockquote>
79</ul></td> 73<a href="ftp.html#get">get</a>,
80<td><ul> 74<a href="ftp.html#get_cb">get_cb</a>,
81 <li><a href="udp.html#send">send</a> 75<a href="ftp.html#put">put</a>,
82 <li><a href="udp.html#sendto">sendto</a> 76<a href="ftp.html#put_cb">put_cb</a>.
83 <li><a href="udp.html#setpeername">setpeername</a> 77</blockquote>
84 <li><a href="udp.html#setsockname">setsockname</a> 78</blockquote>
85 <li><a href="udp.html#setoption">setoption</a> 79
86 <li><a href="udp.html#settimeout">settimeout</a> 80<!-- misc ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
87</ul></td> 81
88</tr> 82<blockquote>
89</table> 83<a href="global.html">Globals (socket)</a>
90 84<blockquote>
91<hr> 85<a href="global.html#bind">bind</a>,
92 86<a href="global.html#callback">callback</a>,
93<!-- http & ftp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 87<a href="global.html#concat">concat</a>,
94 88<a href="global.html#connect">connect</a>,
95<table summary="HTTP and FTP Index" class=index width=100%> 89<a href="global.html#debug">debug</a>,
96<colgroup> <col width="50%"> <col width="50%"> </colgroup> 90<a href="global.html#dns">dns</a>,
97<tr> 91<a href="global.html#ftp">ftp</a>,
98<td valign=top><ul> 92<a href="global.html#http">http</a>,
99<li><a href="http.html">HTTP (socket.http)</a> 93<a href="global.html#mime">mime</a>,
100 <ul> 94<a href="global.html#select">select</a>,
101 <li><a href="http.html#get">get</a> 95<a href="global.html#sleep">sleep</a>,
102 <li><a href="http.html#post">post</a> 96<a href="global.html#smtp">smtp</a>,
103 <li><a href="http.html#request">request</a> 97<a href="global.html#time">time</a>,
104 <li><a href="http.html#request_cb">request_cb</a> 98<a href="global.html#tcp">tcp</a>.
105 </ul> 99<a href="global.html#udp">udp</a>,
106</ul></td> 100<a href="global.html#url">url</a>,
107<td valign=top><ul> 101<a href="global.html#version">version</a>.
108<li><a href="ftp.html">FTP (socket.ftp)</a> 102</blockquote>
109 <ul> 103</blockquote>
110 <li><a href="ftp.html#get">get</a>
111 <li><a href="ftp.html#get_cb">get_cb</a>
112 <li><a href="ftp.html#put">put</a>
113 <li><a href="ftp.html#put_cb">put_cb</a>
114 </ul>
115</ul></td>
116</tr>
117</table> 104</table>
118 105
119<hr>
120 106
121<!-- http & ftp ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 107<!-- http +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
122 108
123<table summary="Streaming Index" class=index width=100%> 109<blockquote>
124<colgroup> <col width="50%"> <col width="50%"> </colgroup> 110<a href="http.html">HTTP (socket.http)</a>
125<tr><td valign=top><ul> 111<blockquote>
126<li><a href="stream.html">Streaming with Callbacks</a> 112<a href="http.html#get">get</a>,
127 <ul> 113<a href="http.html#post">post</a>,
128 <li><a href="stream.html#receive_cb">receive_cb</a> 114<a href="http.html#request">request</a>,
129 <li><a href="stream.html#send_cb">send_cb</a> 115<a href="http.html#request_cb">request_cb</a>.
130 </ul> 116</blockquote>
131</ul></td></tr> 117</blockquote>
132</table> 118
119<!-- mime +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
120
121<blockquote>
122<a href="mime.html">MIME (socket.mime) </a>
123<blockquote>
124<a href="mime.html#filters">filters</a>:
125<a href="mime.html#decode">canonic</a>,
126<a href="mime.html#chain">chain</a>,
127<a href="mime.html#decode">decode</a>,
128<a href="mime.html#encode">encode</a>,
129<a href="mime.html#wrap">wrap</a>.
130</blockquote>
131<blockquote>
132<a href="mime.html#low-level">low-level</a>:
133<a href="mime.html#b64">b64</a>,
134<a href="mime.html#unb64">unb64</a>,
135<a href="mime.html#eol">eol</a>,
136<a href="mime.html#qp">qp</a>,
137<a href="mime.html#unqp">unqp</a>,
138<a href="mime.html#wrp">wrp</a>,
139<a href="mime.html#qpwrp">qpwrp</a>.
140</blockquote>
141</blockquote>
142
143<!-- smtp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
144
145<blockquote>
146<a href="smtp.html">SMTP (socket.smtp)</a>
147<blockquote>
148<a href="smtp.html#mail">mail</a>
149</blockquote>
150</blockquote>
133 151
134<hr> 152<!-- tcp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
135 153
136<!-- smtp & dns ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 154<blockquote>
137 155<a href="tcp.html">TCP (socket.tcp)</a>
138<table summary="SMTP and DNS Index" class=index width=100%> 156<blockquote>
139<colgroup> <col width="50%"> <col width="50%"> </colgroup> 157<a href="tcp.html#accept">accept</a>,
140<tr> 158<a href="tcp.html#bind">bind</a>,
141<td><ul> 159<a href="tcp.html#close">close</a>,
142<li><a href="smtp.html">SMTP (socket.smtp)</a> 160<a href="tcp.html#connect">connect</a>,
143 <ul> 161<a href="tcp.html#getpeername">getpeername</a>,
144 <li> <a href="smtp.html#mail">mail</a> 162<a href="tcp.html#getsockname">getsockname</a>,
145 </ul> 163<a href="tcp.html#receive">receive</a>,
146</ul></td> 164<a href="tcp.html#send">send</a>,
147<td><ul> 165<a href="tcp.html#setoption">setoption</a>,
148<li><a href="dns.html">DNS services (socket.dns)</a> 166<a href="tcp.html#settimeout">settimeout</a>,
149 <ul> 167<a href="tcp.html#shutdown">shutdown</a>.
150 <li><a href="dns.html#toip">toip</a> 168</blockquote>
151 <li><a href="dns.html#tohostname">tohostname</a> 169</blockquote>
152 </ul>
153</ul></td>
154</tr>
155</table>
156 170
157<hr> 171<!-- udp +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
158 172
159<!-- url & code ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 173<blockquote>
160 174<a href="udp.html">UDP (socket.udp)</a>
161<table summary="URL and Code Index" class=index width=100%> 175<blockquote>
162<colgroup> <col width="50%"> <col width="50%"> </colgroup> 176<a href="udp.html#close">close</a>,
163<tr> 177<a href="udp.html#getpeername">getpeername</a>,
164<td valign=top><ul> 178<a href="udp.html#getsockname">getsockname</a>,
165<li><a href="url.html">URL (socket.url) </a> 179<a href="udp.html#receive">receive</a>,
166 <ul> 180<a href="udp.html#receivefrom">receivefrom</a>,
167 <li> <a href="url.html#absolute">absolute</a> 181<a href="udp.html#send">send</a>,
168 <li> <a href="url.html#build">build</a> 182<a href="udp.html#sendto">sendto</a>,
169 <li> <a href="url.html#build_path">build_path</a> 183<a href="udp.html#setpeername">setpeername</a>,
170 <li> <a href="url.html#parse">parse</a> 184<a href="udp.html#setsockname">setsockname</a>,
171 <li> <a href="url.html#parse_path">parse_path</a> 185<a href="udp.html#setoption">setoption</a>,
172 </ul> 186<a href="udp.html#settimeout">settimeout</a>,
173</ul></td> 187<a href="udp.html#settimeout">shutdown</a>.
174<td valign=top><ul> 188</blockquote>
175<li> <a href="code.html">Code (socket.code) </a> 189</blockquote>
176 <ul> 190
177 <li> <a href="code.html#base64">base64</a> 191<!-- url ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
178 <li> <a href="code.html#unbase64">unbase64</a> 192
179 <li> <a href="code.html#escape">escape</a> 193<blockquote>
180 <li> <a href="code.html#unescape">unescape</a> 194<a href="url.html">URL (socket.url) </a>
181 <li> <a href="code.html#hexa">hexa</a> 195<blockquote>
182 <li> <a href="code.html#unhexa">unhexa</a> 196<a href="url.html#absolute">absolute</a>,
183 </ul> 197<a href="url.html#build">build</a>,
184</ul></td> 198<a href="url.html#build_path">build_path</a>,
185</tr> 199<a href="url.html#quote">quote</a>,
186</table> 200<a href="url.html#parse">parse</a>,
201<a href="url.html#parse_path">parse_path</a>,
202<a href="url.html#quote">unquote</a>.
203</blockquote>
204</blockquote>
187 205
188<!-- footer ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ --> 206<!-- footer ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -->
189 207