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.protocol.html">luci.http.protocol</a>
46 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
50 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
54 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.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.jsonc.html">luci.jsonc</a>
74 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
78 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
82 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
86 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
90 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
94 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
98 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
102 <a href="../modules/nixio.html">nixio</a>
106 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
110 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
114 <a href="../modules/nixio.File.html">nixio.File</a>
118 <a href="../modules/nixio.README.html">nixio.README</a>
122 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
126 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
129 <li><strong>nixio.TLSSocket</strong></li>
132 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
136 <a href="../modules/nixio.bin.html">nixio.bin</a>
140 <a href="../modules/nixio.bit.html">nixio.bit</a>
144 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
148 <a href="../modules/nixio.fs.html">nixio.fs</a>
163 </div><!-- id="navigation" -->
167 <h1>Object Instance <code>nixio.TLSSocket</code></h1>
171 TLS Sockets contain the underlying socket and context in the fields
172 "socket" and "context".</p>
181 <table class="function_list">
184 <td class="name" nowrap><a href="#TLSSocket.accept">TLSSocket:accept</a> ()</td>
186 Wait for a TLS handshake from a client.</td>
190 <td class="name" nowrap><a href="#TLSSocket.connect">TLSSocket:connect</a> ()</td>
192 Initiate the TLS handshake as client with the server.</td>
196 <td class="name" nowrap><a href="#TLSSocket.read ">TLSSocket:read </a> (length)</td>
198 Receive a message on the socket (This is an alias for recv).</td>
202 <td class="name" nowrap><a href="#TLSSocket.recv">TLSSocket:recv</a> (length)</td>
204 Receive a message on the socket.</td>
208 <td class="name" nowrap><a href="#TLSSocket.send">TLSSocket:send</a> (buffer, offset, length)</td>
210 Send a message to the socket.</td>
214 <td class="name" nowrap><a href="#TLSSocket.shutdown">TLSSocket:shutdown</a> ()</td>
216 Shut down the TLS connection.</td>
220 <td class="name" nowrap><a href="#TLSSocket.write">TLSSocket:write</a> (buffer, offset, length)</td>
222 Send a message on the socket (This is an alias for send).</td>
236 <h2><a name="functions"></a>Functions</h2>
237 <dl class="function">
241 <dt><a name="TLSSocket.accept"></a><strong>TLSSocket:accept</strong> ()</dt>
244 Wait for a TLS handshake from a client.
253 <li>This function calls SSL_accept().
255 <li>You have to call either connect or accept before transmitting data.
261 <h3>Return value:</h3>
269 <li><a href="#TLSSocket.connect">
280 <dt><a name="TLSSocket.connect"></a><strong>TLSSocket:connect</strong> ()</dt>
283 Initiate the TLS handshake as client with the server.
292 <li>This function calls SSL_connect().
294 <li>You have to call either connect or accept before transmitting data.
300 <h3>Return value:</h3>
308 <li><a href="#TLSSocket.accept">
319 <dt><a name="TLSSocket.read "></a><strong>TLSSocket:read </strong> (length)</dt>
322 Receive a message on the socket (This is an alias for recv).
323 See the recv description for more details.
330 length: Amount of data to read (in Bytes).
340 <h3>Return value:</h3>
341 buffer containing data successfully read
348 <li><a href="#TLSSocket.recv">
359 <dt><a name="TLSSocket.recv"></a><strong>TLSSocket:recv</strong> (length)</dt>
362 Receive a message on the socket.
369 length: Amount of data to read (in Bytes).
380 <li>This function calls SSL_read().
382 <li><strong>Warning:</strong> It is not guaranteed that all requested data
384 You have to check the return value - the length of the buffer actually read -
385 or use the safe IO functions in the high-level IO utility module.
387 <li>The length of the return buffer is limited by the (compile time)
388 nixio buffersize which is <em>nixio.const.buffersize</em> (8192 by default).
389 Any read request greater than that will be safely truncated to this value.
395 <h3>Return value:</h3>
396 buffer containing data successfully read
405 <dt><a name="TLSSocket.send"></a><strong>TLSSocket:send</strong> (buffer, offset, length)</dt>
408 Send a message to the socket.
415 buffer: Buffer holding the data to be written.
419 offset: Offset to start reading the buffer from. (optional)
423 length: Length of chunk to read from the buffer. (optional)
434 <li>This function calls SSL_write().
436 <li><strong>Warning:</strong> It is not guaranteed that all data
437 in the buffer is written at once.
438 You have to check the return value - the number of bytes actually written -
439 or use the safe IO functions in the high-level IO utility module.
441 <li>Unlike standard Lua indexing the lowest offset and default is 0.
447 <h3>Return value:</h3>
448 number of bytes written
457 <dt><a name="TLSSocket.shutdown"></a><strong>TLSSocket:shutdown</strong> ()</dt>
460 Shut down the TLS connection.
467 This function calls SSL_shutdown().
471 <h3>Return value:</h3>
481 <dt><a name="TLSSocket.write"></a><strong>TLSSocket:write</strong> (buffer, offset, length)</dt>
484 Send a message on the socket (This is an alias for send).
485 See the send description for a detailed description.
492 buffer: Buffer holding the data to be written.
496 offset: Offset to start reading the buffer from. (optional)
500 length: Length of chunk to read from the buffer. (optional)
510 <h3>Return value:</h3>
511 number of bytes written
518 <li><a href="#TLSSocket.send">
533 </div> <!-- id="content" -->
535 </div> <!-- id="main" -->
538 <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>
539 </div> <!-- id="about" -->
541 </div> <!-- id="container" -->