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.conditionals.html">luci.http.conditionals</a>
50 <a href="../modules/luci.http.date.html">luci.http.date</a>
54 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
58 <a href="../modules/luci.i18n.html">luci.i18n</a>
62 <a href="../modules/luci.ip.html">luci.ip</a>
66 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
70 <a href="../modules/luci.json.html">luci.json</a>
74 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
78 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
82 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
86 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
90 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
94 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
98 <a href="../modules/luci.sys.html">luci.sys</a>
102 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
106 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
110 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
114 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
118 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
122 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
126 <a href="../modules/luci.util.html">luci.util</a>
130 <a href="../modules/nixio.html">nixio</a>
134 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
138 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
142 <a href="../modules/nixio.File.html">nixio.File</a>
146 <a href="../modules/nixio.README.html">nixio.README</a>
150 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
154 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
157 <li><strong>nixio.TLSSocket</strong></li>
160 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
164 <a href="../modules/nixio.bin.html">nixio.bin</a>
168 <a href="../modules/nixio.bit.html">nixio.bit</a>
172 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
176 <a href="../modules/nixio.fs.html">nixio.fs</a>
191 </div><!-- id="navigation" -->
195 <h1>Object Instance <code>nixio.TLSSocket</code></h1>
199 TLS Sockets contain the underlying socket and context in the fields
200 "socket" and "context".</p>
209 <table class="function_list">
212 <td class="name" nowrap><a href="#TLSSocket.accept">TLSSocket:accept</a> ()</td>
214 Wait for a TLS handshake from a client.</td>
218 <td class="name" nowrap><a href="#TLSSocket.connect">TLSSocket:connect</a> ()</td>
220 Initiate the TLS handshake as client with the server.</td>
224 <td class="name" nowrap><a href="#TLSSocket.read ">TLSSocket:read </a> (length)</td>
226 Receive a message on the socket (This is an alias for recv).</td>
230 <td class="name" nowrap><a href="#TLSSocket.recv">TLSSocket:recv</a> (length)</td>
232 Receive a message on the socket.</td>
236 <td class="name" nowrap><a href="#TLSSocket.send">TLSSocket:send</a> (buffer, offset, length)</td>
238 Send a message to the socket.</td>
242 <td class="name" nowrap><a href="#TLSSocket.shutdown">TLSSocket:shutdown</a> ()</td>
244 Shut down the TLS connection.</td>
248 <td class="name" nowrap><a href="#TLSSocket.write">TLSSocket:write</a> (buffer, offset, length)</td>
250 Send a message on the socket (This is an alias for send).</td>
264 <h2><a name="functions"></a>Functions</h2>
265 <dl class="function">
269 <dt><a name="TLSSocket.accept"></a><strong>TLSSocket:accept</strong> ()</dt>
272 Wait for a TLS handshake from a client.
281 <li>This function calls SSL_accept().
283 <li>You have to call either connect or accept before transmitting data.
289 <h3>Return value:</h3>
297 <li><a href="#TLSSocket.connect">
308 <dt><a name="TLSSocket.connect"></a><strong>TLSSocket:connect</strong> ()</dt>
311 Initiate the TLS handshake as client with the server.
320 <li>This function calls SSL_connect().
322 <li>You have to call either connect or accept before transmitting data.
328 <h3>Return value:</h3>
336 <li><a href="#TLSSocket.accept">
347 <dt><a name="TLSSocket.read "></a><strong>TLSSocket:read </strong> (length)</dt>
350 Receive a message on the socket (This is an alias for recv).
351 See the recv description for more details.
358 length: Amount of data to read (in Bytes).
368 <h3>Return value:</h3>
369 buffer containing data successfully read
376 <li><a href="#TLSSocket.recv">
387 <dt><a name="TLSSocket.recv"></a><strong>TLSSocket:recv</strong> (length)</dt>
390 Receive a message on the socket.
397 length: Amount of data to read (in Bytes).
408 <li>This function calls SSL_read().
410 <li><strong>Warning:</strong> It is not guaranteed that all requested data
412 You have to check the return value - the length of the buffer actually read -
413 or use the safe IO functions in the high-level IO utility module.
415 <li>The length of the return buffer is limited by the (compile time)
416 nixio buffersize which is <em>nixio.const.buffersize</em> (8192 by default).
417 Any read request greater than that will be safely truncated to this value.
423 <h3>Return value:</h3>
424 buffer containing data successfully read
433 <dt><a name="TLSSocket.send"></a><strong>TLSSocket:send</strong> (buffer, offset, length)</dt>
436 Send a message to the socket.
443 buffer: Buffer holding the data to be written.
447 offset: Offset to start reading the buffer from. (optional)
451 length: Length of chunk to read from the buffer. (optional)
462 <li>This function calls SSL_write().
464 <li><strong>Warning:</strong> It is not guaranteed that all data
465 in the buffer is written at once.
466 You have to check the return value - the number of bytes actually written -
467 or use the safe IO functions in the high-level IO utility module.
469 <li>Unlike standard Lua indexing the lowest offset and default is 0.
475 <h3>Return value:</h3>
476 number of bytes written
485 <dt><a name="TLSSocket.shutdown"></a><strong>TLSSocket:shutdown</strong> ()</dt>
488 Shut down the TLS connection.
495 This function calls SSL_shutdown().
499 <h3>Return value:</h3>
509 <dt><a name="TLSSocket.write"></a><strong>TLSSocket:write</strong> (buffer, offset, length)</dt>
512 Send a message on the socket (This is an alias for send).
513 See the send description for a detailed description.
520 buffer: Buffer holding the data to be written.
524 offset: Offset to start reading the buffer from. (optional)
528 length: Length of chunk to read from the buffer. (optional)
538 <h3>Return value:</h3>
539 number of bytes written
546 <li><a href="#TLSSocket.send">
561 </div> <!-- id="content" -->
563 </div> <!-- id="main" -->
566 <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>
567 </div> <!-- id="about" -->
569 </div> <!-- id="container" -->