1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
5 <title>Reference</title>
6 <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7 <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17 </div> <!-- id="product" -->
27 <li><a href="../index.html">Index</a></li>
38 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
42 <a href="../modules/luci.http.html">luci.http</a>
46 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
50 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
54 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
58 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
62 <a href="../modules/luci.i18n.html">luci.i18n</a>
66 <a href="../modules/luci.ip.html">luci.ip</a>
70 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
74 <a href="../modules/luci.json.html">luci.json</a>
78 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
82 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
86 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
90 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
94 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
98 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
102 <a href="../modules/luci.sys.html">luci.sys</a>
106 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
110 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
114 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
118 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
122 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
126 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
130 <a href="../modules/luci.util.html">luci.util</a>
134 <a href="../modules/nixio.html">nixio</a>
138 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
142 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
146 <a href="../modules/nixio.File.html">nixio.File</a>
150 <a href="../modules/nixio.README.html">nixio.README</a>
154 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
158 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
161 <li><strong>nixio.TLSSocket</strong></li>
164 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
168 <a href="../modules/nixio.bin.html">nixio.bin</a>
172 <a href="../modules/nixio.bit.html">nixio.bit</a>
176 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
180 <a href="../modules/nixio.fs.html">nixio.fs</a>
195 </div><!-- id="navigation" -->
199 <h1>Object Instance <code>nixio.TLSSocket</code></h1>
203 TLS Sockets contain the underlying socket and context in the fields
204 "socket" and "context".</p>
213 <table class="function_list">
216 <td class="name" nowrap><a href="#TLSSocket.accept">TLSSocket:accept</a> ()</td>
218 Wait for a TLS handshake from a client.</td>
222 <td class="name" nowrap><a href="#TLSSocket.connect">TLSSocket:connect</a> ()</td>
224 Initiate the TLS handshake as client with the server.</td>
228 <td class="name" nowrap><a href="#TLSSocket.read ">TLSSocket:read </a> (length)</td>
230 Receive a message on the socket (This is an alias for recv).</td>
234 <td class="name" nowrap><a href="#TLSSocket.recv">TLSSocket:recv</a> (length)</td>
236 Receive a message on the socket.</td>
240 <td class="name" nowrap><a href="#TLSSocket.send">TLSSocket:send</a> (buffer, offset, length)</td>
242 Send a message to the socket.</td>
246 <td class="name" nowrap><a href="#TLSSocket.shutdown">TLSSocket:shutdown</a> ()</td>
248 Shut down the TLS connection.</td>
252 <td class="name" nowrap><a href="#TLSSocket.write">TLSSocket:write</a> (buffer, offset, length)</td>
254 Send a message on the socket (This is an alias for send).</td>
268 <h2><a name="functions"></a>Functions</h2>
269 <dl class="function">
273 <dt><a name="TLSSocket.accept"></a><strong>TLSSocket:accept</strong> ()</dt>
276 Wait for a TLS handshake from a client.
285 <li>This function calls SSL_accept().
287 <li>You have to call either connect or accept before transmitting data.
293 <h3>Return value:</h3>
301 <li><a href="#TLSSocket.connect">
312 <dt><a name="TLSSocket.connect"></a><strong>TLSSocket:connect</strong> ()</dt>
315 Initiate the TLS handshake as client with the server.
324 <li>This function calls SSL_connect().
326 <li>You have to call either connect or accept before transmitting data.
332 <h3>Return value:</h3>
340 <li><a href="#TLSSocket.accept">
351 <dt><a name="TLSSocket.read "></a><strong>TLSSocket:read </strong> (length)</dt>
354 Receive a message on the socket (This is an alias for recv).
355 See the recv description for more details.
362 length: Amount of data to read (in Bytes).
372 <h3>Return value:</h3>
373 buffer containing data successfully read
380 <li><a href="#TLSSocket.recv">
391 <dt><a name="TLSSocket.recv"></a><strong>TLSSocket:recv</strong> (length)</dt>
394 Receive a message on the socket.
401 length: Amount of data to read (in Bytes).
412 <li>This function calls SSL_read().
414 <li><strong>Warning:</strong> It is not guaranteed that all requested data
416 You have to check the return value - the length of the buffer actually read -
417 or use the safe IO functions in the high-level IO utility module.
419 <li>The length of the return buffer is limited by the (compile time)
420 nixio buffersize which is <em>nixio.const.buffersize</em> (8192 by default).
421 Any read request greater than that will be safely truncated to this value.
427 <h3>Return value:</h3>
428 buffer containing data successfully read
437 <dt><a name="TLSSocket.send"></a><strong>TLSSocket:send</strong> (buffer, offset, length)</dt>
440 Send a message to the socket.
447 buffer: Buffer holding the data to be written.
451 offset: Offset to start reading the buffer from. (optional)
455 length: Length of chunk to read from the buffer. (optional)
466 <li>This function calls SSL_write().
468 <li><strong>Warning:</strong> It is not guaranteed that all data
469 in the buffer is written at once.
470 You have to check the return value - the number of bytes actually written -
471 or use the safe IO functions in the high-level IO utility module.
473 <li>Unlike standard Lua indexing the lowest offset and default is 0.
479 <h3>Return value:</h3>
480 number of bytes written
489 <dt><a name="TLSSocket.shutdown"></a><strong>TLSSocket:shutdown</strong> ()</dt>
492 Shut down the TLS connection.
499 This function calls SSL_shutdown().
503 <h3>Return value:</h3>
513 <dt><a name="TLSSocket.write"></a><strong>TLSSocket:write</strong> (buffer, offset, length)</dt>
516 Send a message on the socket (This is an alias for send).
517 See the send description for a detailed description.
524 buffer: Buffer holding the data to be written.
528 offset: Offset to start reading the buffer from. (optional)
532 length: Length of chunk to read from the buffer. (optional)
542 <h3>Return value:</h3>
543 number of bytes written
550 <li><a href="#TLSSocket.send">
565 </div> <!-- id="content" -->
567 </div> <!-- id="main" -->
570 <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>
571 </div> <!-- id="about" -->
573 </div> <!-- id="container" -->