luci.json.html 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <head>
  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"/-->
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <div id="navigation">
  18. <h1>LuaDoc</h1>
  19. <ul>
  20. <li><a href="../index.html">Index</a></li>
  21. </ul>
  22. <!-- Module list -->
  23. <h1>Modules</h1>
  24. <ul>
  25. <li>
  26. <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  27. </li>
  28. <li>
  29. <a href="../modules/luci.http.html">luci.http</a>
  30. </li>
  31. <li>
  32. <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  33. </li>
  34. <li>
  35. <a href="../modules/luci.http.date.html">luci.http.date</a>
  36. </li>
  37. <li>
  38. <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  39. </li>
  40. <li>
  41. <a href="../modules/luci.i18n.html">luci.i18n</a>
  42. </li>
  43. <li>
  44. <a href="../modules/luci.ip.html">luci.ip</a>
  45. </li>
  46. <li>
  47. <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  48. </li>
  49. <li><strong>luci.json</strong></li>
  50. <li>
  51. <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  52. </li>
  53. <li>
  54. <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  55. </li>
  56. <li>
  57. <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  58. </li>
  59. <li>
  60. <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  61. </li>
  62. <li>
  63. <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  64. </li>
  65. <li>
  66. <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  67. </li>
  68. <li>
  69. <a href="../modules/luci.sys.html">luci.sys</a>
  70. </li>
  71. <li>
  72. <a href="../modules/luci.sys.init.html">luci.sys.init</a>
  73. </li>
  74. <li>
  75. <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
  76. </li>
  77. <li>
  78. <a href="../modules/luci.sys.net.html">luci.sys.net</a>
  79. </li>
  80. <li>
  81. <a href="../modules/luci.sys.process.html">luci.sys.process</a>
  82. </li>
  83. <li>
  84. <a href="../modules/luci.sys.user.html">luci.sys.user</a>
  85. </li>
  86. <li>
  87. <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
  88. </li>
  89. <li>
  90. <a href="../modules/luci.util.html">luci.util</a>
  91. </li>
  92. <li>
  93. <a href="../modules/luci.xml.html">luci.xml</a>
  94. </li>
  95. <li>
  96. <a href="../modules/nixio.html">nixio</a>
  97. </li>
  98. <li>
  99. <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
  100. </li>
  101. <li>
  102. <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
  103. </li>
  104. <li>
  105. <a href="../modules/nixio.File.html">nixio.File</a>
  106. </li>
  107. <li>
  108. <a href="../modules/nixio.README.html">nixio.README</a>
  109. </li>
  110. <li>
  111. <a href="../modules/nixio.Socket.html">nixio.Socket</a>
  112. </li>
  113. <li>
  114. <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
  115. </li>
  116. <li>
  117. <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
  118. </li>
  119. <li>
  120. <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
  121. </li>
  122. <li>
  123. <a href="../modules/nixio.bin.html">nixio.bin</a>
  124. </li>
  125. <li>
  126. <a href="../modules/nixio.bit.html">nixio.bit</a>
  127. </li>
  128. <li>
  129. <a href="../modules/nixio.crypto.html">nixio.crypto</a>
  130. </li>
  131. <li>
  132. <a href="../modules/nixio.fs.html">nixio.fs</a>
  133. </li>
  134. </ul>
  135. <!-- File list -->
  136. </div><!-- id="navigation" -->
  137. <div id="content">
  138. <h1>Object Instance <code>luci.json</code></h1>
  139. <p></p>
  140. <h2>Functions</h2>
  141. <table class="function_list">
  142. <tr>
  143. <td class="name" nowrap><a href="#ActiveDecoder">ActiveDecoder</a>&nbsp;(customnull)</td>
  144. <td class="summary">
  145. Create a new Active JSON-Decoder.</td>
  146. </tr>
  147. <tr>
  148. <td class="name" nowrap><a href="#ActiveDecoder.get">ActiveDecoder:get</a>&nbsp;()</td>
  149. <td class="summary">
  150. Fetches one JSON-object from given source
  151. </td>
  152. </tr>
  153. <tr>
  154. <td class="name" nowrap><a href="#Decoder">Decoder</a>&nbsp;(customnull)</td>
  155. <td class="summary">
  156. Create a new JSON-Decoder.</td>
  157. </tr>
  158. <tr>
  159. <td class="name" nowrap><a href="#Decoder.get">Decoder:get</a>&nbsp;()</td>
  160. <td class="summary">
  161. Get the decoded data packets after the rawdata has been sent to the sink.</td>
  162. </tr>
  163. <tr>
  164. <td class="name" nowrap><a href="#Decoder.sink">Decoder:sink</a>&nbsp;()</td>
  165. <td class="summary">
  166. Create an LTN12 sink from the decoder object which accepts the JSON-Data.</td>
  167. </tr>
  168. <tr>
  169. <td class="name" nowrap><a href="#Encoder">Encoder</a>&nbsp;(data, buffersize, fastescape)</td>
  170. <td class="summary">
  171. Create a new JSON-Encoder.</td>
  172. </tr>
  173. <tr>
  174. <td class="name" nowrap><a href="#Encoder.source">Encoder:source</a>&nbsp;()</td>
  175. <td class="summary">
  176. Create an LTN12 source providing the encoded JSON-Data.</td>
  177. </tr>
  178. <tr>
  179. <td class="name" nowrap><a href="#decode">decode</a>&nbsp;(json)</td>
  180. <td class="summary">
  181. Directly decode a JSON string
  182. </td>
  183. </tr>
  184. <tr>
  185. <td class="name" nowrap><a href="#encode">encode</a>&nbsp;(obj)</td>
  186. <td class="summary">
  187. Direcly encode a Lua object into a JSON string.</td>
  188. </tr>
  189. <tr>
  190. <td class="name" nowrap><a href="#null">null</a>&nbsp;()</td>
  191. <td class="summary">
  192. Null replacement function
  193. </td>
  194. </tr>
  195. </table>
  196. <br/>
  197. <br/>
  198. <h2><a name="functions"></a>Functions</h2>
  199. <dl class="function">
  200. <dt><a name="ActiveDecoder"></a><strong>ActiveDecoder</strong>&nbsp;(customnull)</dt>
  201. <dd>
  202. Create a new Active JSON-Decoder.
  203. <h3>Parameters</h3>
  204. <ul>
  205. <li>
  206. customnull: Use luci.json.null instead of nil for decoding null
  207. </li>
  208. </ul>
  209. <h3>Return value:</h3>
  210. Active JSON-Decoder
  211. </dd>
  212. <dt><a name="ActiveDecoder.get"></a><strong>ActiveDecoder:get</strong>&nbsp;()</dt>
  213. <dd>
  214. Fetches one JSON-object from given source
  215. <h3>Return value:</h3>
  216. Decoded object
  217. </dd>
  218. <dt><a name="Decoder"></a><strong>Decoder</strong>&nbsp;(customnull)</dt>
  219. <dd>
  220. Create a new JSON-Decoder.
  221. <h3>Parameters</h3>
  222. <ul>
  223. <li>
  224. customnull: Use luci.json.null instead of nil for decoding null
  225. </li>
  226. </ul>
  227. <h3>Return value:</h3>
  228. JSON-Decoder
  229. </dd>
  230. <dt><a name="Decoder.get"></a><strong>Decoder:get</strong>&nbsp;()</dt>
  231. <dd>
  232. Get the decoded data packets after the rawdata has been sent to the sink.
  233. <h3>Return value:</h3>
  234. Decoded data
  235. </dd>
  236. <dt><a name="Decoder.sink"></a><strong>Decoder:sink</strong>&nbsp;()</dt>
  237. <dd>
  238. Create an LTN12 sink from the decoder object which accepts the JSON-Data.
  239. <h3>Return value:</h3>
  240. LTN12 sink
  241. </dd>
  242. <dt><a name="Encoder"></a><strong>Encoder</strong>&nbsp;(data, buffersize, fastescape)</dt>
  243. <dd>
  244. Create a new JSON-Encoder.
  245. <h3>Parameters</h3>
  246. <ul>
  247. <li>
  248. data: Lua-Object to be encoded.
  249. </li>
  250. <li>
  251. buffersize: Blocksize of returned data source.
  252. </li>
  253. <li>
  254. fastescape: Use non-standard escaping (don't escape control chars)
  255. </li>
  256. </ul>
  257. <h3>Return value:</h3>
  258. JSON-Encoder
  259. </dd>
  260. <dt><a name="Encoder.source"></a><strong>Encoder:source</strong>&nbsp;()</dt>
  261. <dd>
  262. Create an LTN12 source providing the encoded JSON-Data.
  263. <h3>Return value:</h3>
  264. LTN12 source
  265. </dd>
  266. <dt><a name="decode"></a><strong>decode</strong>&nbsp;(json)</dt>
  267. <dd>
  268. Directly decode a JSON string
  269. <h3>Parameters</h3>
  270. <ul>
  271. <li>
  272. json: JSON-String
  273. </li>
  274. </ul>
  275. <h3>Return value:</h3>
  276. Lua object
  277. </dd>
  278. <dt><a name="encode"></a><strong>encode</strong>&nbsp;(obj)</dt>
  279. <dd>
  280. Direcly encode a Lua object into a JSON string.
  281. <h3>Parameters</h3>
  282. <ul>
  283. <li>
  284. obj: Lua Object
  285. </li>
  286. </ul>
  287. <h3>Return value:</h3>
  288. JSON string
  289. </dd>
  290. <dt><a name="null"></a><strong>null</strong>&nbsp;()</dt>
  291. <dd>
  292. Null replacement function
  293. <h3>Return value:</h3>
  294. null
  295. </dd>
  296. </dl>
  297. </div> <!-- id="content" -->
  298. </div> <!-- id="main" -->
  299. <div id="about">
  300. <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>
  301. </div> <!-- id="about" -->
  302. </div> <!-- id="container" -->
  303. </body>
  304. </html>