1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../luadoc.css" type="text/css" />
<!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<div id="navigation">
<h1>LuaDoc</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<!-- Module list -->
<h1>Modules</h1>
<ul>
<li>
<a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
</li>
<li>
<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
</li>
<li>
<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
</li>
<li>
<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
</li>
<li>
<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
</li>
<li>
<a href="../modules/luci.i18n.html">luci.i18n</a>
</li>
<li>
<a href="../modules/luci.ip.html">luci.ip</a>
</li>
<li>
<a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
</li>
<li>
<a href="../modules/luci.jsonc.html">luci.jsonc</a>
</li>
<li>
<a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
</li>
<li>
<a href="../modules/luci.sys.init.html">luci.sys.init</a>
</li>
<li>
<a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
</li>
<li>
<a href="../modules/luci.sys.net.html">luci.sys.net</a>
</li>
<li>
<a href="../modules/luci.sys.process.html">luci.sys.process</a>
</li>
<li>
<a href="../modules/luci.sys.user.html">luci.sys.user</a>
</li>
<li>
<a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
</li>
<li>
<a href="../modules/nixio.html">nixio</a>
</li>
<li>
<a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
</li>
<li>
<a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
</li>
<li>
<a href="../modules/nixio.File.html">nixio.File</a>
</li>
<li><strong>nixio.README</strong></li>
<li>
<a href="../modules/nixio.Socket.html">nixio.Socket</a>
</li>
<li>
<a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
</li>
<li>
<a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
</li>
<li>
<a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
</li>
<li>
<a href="../modules/nixio.bin.html">nixio.bin</a>
</li>
<li>
<a href="../modules/nixio.bit.html">nixio.bit</a>
</li>
<li>
<a href="../modules/nixio.crypto.html">nixio.crypto</a>
</li>
<li>
<a href="../modules/nixio.fs.html">nixio.fs</a>
</li>
</ul>
<!-- File list -->
</div><!-- id="navigation" -->
<div id="content">
<h1>Class <code>nixio.README</code></h1>
<p>
General Information.</p>
<h2>Tables</h2>
<table class="table_list">
<tr>
<td class="name" nowrap><a href="#Errorhandling">Errorhandling</a></td>
<td class="summary">
General error handling information.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Functions">Functions</a></td>
<td class="summary">
Function conventions.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#Platforms">Platforms</a></td>
<td class="summary">
Platform information.</td>
</tr>
<tr>
<td class="name" nowrap><a href="#TLS-Crypto">TLS-Crypto</a></td>
<td class="summary">
Cryptography and TLS libraries.</td>
</tr>
</table>
<br/>
<br/>
<h2><a name="tables"></a>Tables</h2>
<dl class="table">
<dt><a name="Errorhandling"></a><strong>Errorhandling</strong></dt>
<dd>
General error handling information.
<ul>
<li> Most of the functions available in this library may fail. If any error
occurs the function returns <strong>nil or false</strong>, an error code
(usually errno) and an additional error message text (if avaialable).</li>
<li>At the moment false is only returned when a non-blocking I/O function
fails with EAGAIN, EWOULDBLOCK or WSAEWOULDBLOCK for any others nil is
returned as first parameter. Therefore you can use false to write portable
non-blocking I/O applications.</li>
<li>Note that the function documentation does only mention the return values
in case of a successful operation.</li>
<li>You can find a table of common error numbers and other useful constants
like signal numbers in <strong>nixio.const</strong> e.g. nixio.const.EINVAL,
nixio.const.SIGTERM, etc. For portability there is a second error constant
table <strong>nixio.const_sock</strong> for socket error codes. This might
be important if you are dealing with Windows applications, on POSIX however
const_sock is just an alias for const.</li>
<li>With some exceptions - which are explicitely stated in the function
documentation - all blocking functions are signal-protected and will not fail
with EINTR.</li>
<li>On POSIX the SIGPIPE signal will be set to ignore upon initialization.
You should restore the default behaviour or set a custom signal handler
in your program after loading nixio if you need this behaviour.</li>
</ul>
</dd>
<dt><a name="Functions"></a><strong>Functions</strong></dt>
<dd>
Function conventions.
<br />In general all functions are namend and behave like their POSIX API
counterparts - where applicable - applying the following rules:
<ul>
<li>Functions should be named like the underlying POSIX API function ommiting
prefixes or suffixes - especially when placed in an object-context (
lockf -> File:lock, fsync -> File:sync, dup2 -> dup, ...)</li>
<li>If you are unclear about the behaviour of a function you should consult
your OS API documentation (e.g. the manpages).</li>
<li>If the name is significantly different from the POSIX-function, the
underlying function(s) are stated in the documentation.</li>
<li>Parameters should reflect those of the C-API, buffer length arguments and
by-reference parameters should be ommitted for pratical purposes.</li>
<li>If a C function accepts a bitfield as parameter, it should be translated
into lower case string flags representing the flags if the bitfield is the
last parameter and also ommiting prefixes or suffixes. (e.g. waitpid
(pid, &s, WNOHANG | WUNTRACED) -> waitpid(pid, "nohang", "untraced"),
getsockopt(fd, SOL_SOCKET, SO_REUSEADDR, &opt, sizeof(opt)) ->
Socket:getopt("socket", "reuseaddr"), etc.) </li>
<li>If it is not applicable to provide a string representation of the
bitfield a bitfield generator helper is provided. It is named FUNCTION_flags.
(open("/tmp/test", O_RDONLY | O_NONBLOCK) -> open("/tmp/test", open_flags(
"rdonly", "nonblock")))</li>
</ul>
</dd>
<dt><a name="Platforms"></a><strong>Platforms</strong></dt>
<dd>
Platform information.
<ul>
<li>The minimum platform requirements are a decent POSIX 2001 support.
Builds are more or less tested on Linux, Solaris and FreeBSD. Builds for
Windows XP SP1 and later can be compiled with MinGW either from Windows
itself or using the MinGW cross-compiler. Earlier versions of Windows are not
supported.</li>
<li>In general all functions which don't have any remarks
in their documentation are available on all platforms.</li>
<li>Functions with a (POSIX), (Linux) or similar prefix are only available
on these specific platforms. Same appplies to parameters of functions
with a similar suffix.</li>
<li>Some functions might have limitations on some platforms. This should
be stated in the documentation. Please also consult your OS API
documentation.</li>
</ul>
</dd>
<dt><a name="TLS-Crypto"></a><strong>TLS-Crypto</strong></dt>
<dd>
Cryptography and TLS libraries.
<ul>
<li>Currently 3 underlying cryptography libraries are supported: openssl,
cyassl and axTLS. The name of the library in use is written to
<strong>nixio.tls_provider</strong></li>
<li>You should whenever possible use openssl or cyassl as axTLS has only
limited support. It does not provide support for non-blocking sockets and
is probably less audited than the other ones.</li>
<li>As the supported Windows versions are not suitable for embedded devices
axTLS is at the moment not supported on Windows.</li>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>
|
