854 lines
11 KiB
HTML
854 lines
11 KiB
HTML
<!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><strong>luci.http</strong></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.json.html">luci.json</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.model.ipkg.html">luci.model.ipkg</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../modules/luci.model.uci.html">luci.model.uci</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../modules/luci.rpcc.html">luci.rpcc</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
|
|
</li>
|
|
|
|
<li>
|
|
<a href="../modules/luci.sys.html">luci.sys</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/luci.util.html">luci.util</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>
|
|
<a href="../modules/nixio.README.html">nixio.README</a>
|
|
</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>luci.http</code></h1>
|
|
|
|
<p></p>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h2>Functions</h2>
|
|
<table class="function_list">
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#build_querystring">build_querystring</a> (table)</td>
|
|
<td class="summary">
|
|
|
|
Create a querystring out of a table of key - value pairs.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#close">close</a> ()</td>
|
|
<td class="summary">
|
|
|
|
Close the HTTP-Connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#content">content</a> ()</td>
|
|
<td class="summary">
|
|
|
|
Return the request content if the request was of unknown type.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#formvalue">formvalue</a> (name, noparse)</td>
|
|
<td class="summary">
|
|
|
|
Get a certain HTTP input value or a table of all input values.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#formvaluetable">formvaluetable</a> (prefix)</td>
|
|
<td class="summary">
|
|
|
|
Get a table of all HTTP input values with a certain prefix.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#getcookie">getcookie</a> (name)</td>
|
|
<td class="summary">
|
|
|
|
Get the value of a certain HTTP-Cookie.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#getenv">getenv</a> (name)</td>
|
|
<td class="summary">
|
|
|
|
Get the value of a certain HTTP environment variable
|
|
|
|
or the environment table itself.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#header">header</a> (key, value)</td>
|
|
<td class="summary">
|
|
|
|
Send a HTTP-Header.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#prepare_content">prepare_content</a> (mime)</td>
|
|
<td class="summary">
|
|
|
|
Set the mime type of following content data.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#redirect">redirect</a> (url)</td>
|
|
<td class="summary">
|
|
|
|
Redirects the client to a new URL and closes the connection.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#setfilehandler">setfilehandler</a> (callback)</td>
|
|
<td class="summary">
|
|
|
|
Set a handler function for incoming user file uploads.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#source">source</a> ()</td>
|
|
<td class="summary">
|
|
|
|
Get the RAW HTTP input source
|
|
</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#splice">splice</a> (fp, size)</td>
|
|
<td class="summary">
|
|
|
|
Splice data from a filedescriptor to the client.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#status">status</a> (code, message)</td>
|
|
<td class="summary">
|
|
|
|
Set the HTTP status code and status message.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#write">write</a> (content, src_err)</td>
|
|
<td class="summary">
|
|
|
|
Send a chunk of content data to the client.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td class="name" nowrap><a href="#write_json">write_json</a> (data)</td>
|
|
<td class="summary">
|
|
|
|
Send the given data as JSON encoded string.</td>
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|
|
|
<h2><a name="functions"></a>Functions</h2>
|
|
<dl class="function">
|
|
|
|
|
|
|
|
<dt><a name="build_querystring"></a><strong>build_querystring</strong> (table)</dt>
|
|
<dd>
|
|
|
|
|
|
Create a querystring out of a table of key - value pairs.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
table: Query string source table
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
Encoded HTTP query string
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="close"></a><strong>close</strong> ()</dt>
|
|
<dd>
|
|
|
|
|
|
Close the HTTP-Connection.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="content"></a><strong>content</strong> ()</dt>
|
|
<dd>
|
|
|
|
|
|
Return the request content if the request was of unknown type.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return values:</h3>
|
|
<ol>
|
|
|
|
<li>HTTP request body
|
|
|
|
<li>HTTP request body length
|
|
|
|
</ol>
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="formvalue"></a><strong>formvalue</strong> (name, noparse)</dt>
|
|
<dd>
|
|
|
|
|
|
Get a certain HTTP input value or a table of all input values.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
name: Name of the GET or POST variable to fetch
|
|
</li>
|
|
|
|
<li>
|
|
noparse: Don't parse POST data before getting the value
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
HTTP input value or table of all input value
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="formvaluetable"></a><strong>formvaluetable</strong> (prefix)</dt>
|
|
<dd>
|
|
|
|
|
|
Get a table of all HTTP input values with a certain prefix.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
prefix: Prefix
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
Table of all HTTP input values with given prefix
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="getcookie"></a><strong>getcookie</strong> (name)</dt>
|
|
<dd>
|
|
|
|
|
|
Get the value of a certain HTTP-Cookie.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
name: Cookie Name
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
String containing cookie data
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="getenv"></a><strong>getenv</strong> (name)</dt>
|
|
<dd>
|
|
|
|
|
|
Get the value of a certain HTTP environment variable
|
|
|
|
or the environment table itself.
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
name: Environment variable
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
HTTP environment value or environment table
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="header"></a><strong>header</strong> (key, value)</dt>
|
|
<dd>
|
|
|
|
|
|
Send a HTTP-Header.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
key: Header key
|
|
</li>
|
|
|
|
<li>
|
|
value: Header value
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="prepare_content"></a><strong>prepare_content</strong> (mime)</dt>
|
|
<dd>
|
|
|
|
|
|
Set the mime type of following content data.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
mime: Mimetype of following content
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="redirect"></a><strong>redirect</strong> (url)</dt>
|
|
<dd>
|
|
|
|
|
|
Redirects the client to a new URL and closes the connection.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
url: Target URL
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="setfilehandler"></a><strong>setfilehandler</strong> (callback)</dt>
|
|
<dd>
|
|
|
|
|
|
Set a handler function for incoming user file uploads.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
callback: Handler function
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="source"></a><strong>source</strong> ()</dt>
|
|
<dd>
|
|
|
|
|
|
Get the RAW HTTP input source
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>Return value:</h3>
|
|
HTTP LTN12 source
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="splice"></a><strong>splice</strong> (fp, size)</dt>
|
|
<dd>
|
|
|
|
|
|
Splice data from a filedescriptor to the client.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
fp: File descriptor
|
|
</li>
|
|
|
|
<li>
|
|
size: Bytes to splice (optional)
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="status"></a><strong>status</strong> (code, message)</dt>
|
|
<dd>
|
|
|
|
|
|
Set the HTTP status code and status message.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
code: Status code
|
|
</li>
|
|
|
|
<li>
|
|
message: Status message
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="write"></a><strong>write</strong> (content, src_err)</dt>
|
|
<dd>
|
|
|
|
|
|
Send a chunk of content data to the client.
|
|
|
|
This function is as a valid LTN12 sink.
|
|
If the content chunk is nil this function will automatically invoke close.
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
content: Content chunk
|
|
</li>
|
|
|
|
<li>
|
|
src_err: Error object from source (optional)
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3>See also:</h3>
|
|
<ul>
|
|
|
|
<li><a href="#close">
|
|
close
|
|
</a>
|
|
|
|
</ul>
|
|
|
|
</dd>
|
|
|
|
|
|
|
|
|
|
<dt><a name="write_json"></a><strong>write_json</strong> (data)</dt>
|
|
<dd>
|
|
|
|
|
|
Send the given data as JSON encoded string.
|
|
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
<ul>
|
|
|
|
<li>
|
|
data: Data to send
|
|
</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>
|