documentation/api/modules/luci.json.html

   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
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  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" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.conditionals.html">luci.http.conditionals</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.date.html">luci.http.date</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.mime.html">luci.http.mime</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.ip.html">luci.ip</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  67         </li>
  68
  69         <li><strong>luci.json</strong></li>
  70
  71         <li>
  72                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  73         </li>
  74
  75         <li>
  76                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  77         </li>
  78
  79         <li>
  80                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  81         </li>
  82
  83         <li>
  84                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  85         </li>
  86
  87         <li>
  88                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  89         </li>
  90
  91         <li>
  92                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  93         </li>
  94
  95         <li>
  96                 <a href="../modules/luci.sys.html">luci.sys</a>
  97         </li>
  98
  99         <li>
 100                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 101         </li>
 102
 103         <li>
 104                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 105         </li>
 106
 107         <li>
 108                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 109         </li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.util.html">luci.util</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/nixio.html">nixio</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.File.html">nixio.File</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.README.html">nixio.README</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 177         </li>
 178
 179 </ul>
 180
 181
 182
 183 <!-- File list -->
 184
 185
 186
 187
 188
 189
 190
 191 </div><!-- id="navigation" -->
 192
 193 <div id="content">
 194
 195 <h1>Object Instance <code>luci.json</code></h1>
 196
 197 <p></p>
 198
 199
 200
 201
 202
 203
 204
 205 <h2>Functions</h2>
 206 <table class="function_list">
 207
 208         <tr>
 209         <td class="name" nowrap><a href="#ActiveDecoder">ActiveDecoder</a>&nbsp;(customnull)</td>
 210         <td class="summary">
 211
 212 Create a new Active JSON-Decoder.</td>
 213         </tr>
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#ActiveDecoder.get">ActiveDecoder:get</a>&nbsp;()</td>
 217         <td class="summary">
 218
 219 Fetches one JSON-object from given source
 220  </td>
 221         </tr>
 222
 223         <tr>
 224         <td class="name" nowrap><a href="#Decoder">Decoder</a>&nbsp;(customnull)</td>
 225         <td class="summary">
 226
 227 Create a new JSON-Decoder.</td>
 228         </tr>
 229
 230         <tr>
 231         <td class="name" nowrap><a href="#Decoder.get">Decoder:get</a>&nbsp;()</td>
 232         <td class="summary">
 233
 234 Get the decoded data packets after the rawdata has been sent to the sink.</td>
 235         </tr>
 236
 237         <tr>
 238         <td class="name" nowrap><a href="#Decoder.sink">Decoder:sink</a>&nbsp;()</td>
 239         <td class="summary">
 240
 241 Create an LTN12 sink from the decoder object which accepts the JSON-Data.</td>
 242         </tr>
 243
 244         <tr>
 245         <td class="name" nowrap><a href="#Encoder">Encoder</a>&nbsp;(data, buffersize, fastescape)</td>
 246         <td class="summary">
 247
 248 Create a new JSON-Encoder.</td>
 249         </tr>
 250
 251         <tr>
 252         <td class="name" nowrap><a href="#Encoder.source">Encoder:source</a>&nbsp;()</td>
 253         <td class="summary">
 254
 255 Create an LTN12 source providing the encoded JSON-Data.</td>
 256         </tr>
 257
 258         <tr>
 259         <td class="name" nowrap><a href="#decode">decode</a>&nbsp;(json)</td>
 260         <td class="summary">
 261
 262 Directly decode a JSON string
 263  </td>
 264         </tr>
 265
 266         <tr>
 267         <td class="name" nowrap><a href="#encode">encode</a>&nbsp;(obj)</td>
 268         <td class="summary">
 269
 270 Direcly encode a Lua object into a JSON string.</td>
 271         </tr>
 272
 273         <tr>
 274         <td class="name" nowrap><a href="#null">null</a>&nbsp;()</td>
 275         <td class="summary">
 276
 277 Null replacement function
 278  </td>
 279         </tr>
 280
 281 </table>
 282
 283
 284
 285
 286
 287
 288 <br/>
 289 <br/>
 290
 291
 292 <h2><a name="functions"></a>Functions</h2>
 293 <dl class="function">
 294
 295
 296
 297 <dt><a name="ActiveDecoder"></a><strong>ActiveDecoder</strong>&nbsp;(customnull)</dt>
 298 <dd>
 299
 300
 301 Create a new Active JSON-Decoder.
 302
 303
 304
 305 <h3>Parameters</h3>
 306 <ul>
 307
 308         <li>
 309           customnull: Use luci.json.null instead of nil for decoding null
 310         </li>
 311
 312 </ul>
 313
 314
 315
 316
 317
 318
 319 <h3>Return value:</h3>
 320 Active JSON-Decoder
 321
 322
 323
 324 </dd>
 325
 326
 327
 328
 329 <dt><a name="ActiveDecoder.get"></a><strong>ActiveDecoder:get</strong>&nbsp;()</dt>
 330 <dd>
 331
 332
 333 Fetches one JSON-object from given source
 334
 335
 336
 337
 338
 339
 340
 341
 342 <h3>Return value:</h3>
 343 Decoded object
 344
 345
 346
 347 </dd>
 348
 349
 350
 351
 352 <dt><a name="Decoder"></a><strong>Decoder</strong>&nbsp;(customnull)</dt>
 353 <dd>
 354
 355
 356 Create a new JSON-Decoder.
 357
 358
 359
 360 <h3>Parameters</h3>
 361 <ul>
 362
 363         <li>
 364           customnull: Use luci.json.null instead of nil for decoding null
 365         </li>
 366
 367 </ul>
 368
 369
 370
 371
 372
 373
 374 <h3>Return value:</h3>
 375 JSON-Decoder
 376
 377
 378
 379 </dd>
 380
 381
 382
 383
 384 <dt><a name="Decoder.get"></a><strong>Decoder:get</strong>&nbsp;()</dt>
 385 <dd>
 386
 387
 388 Get the decoded data packets after the rawdata has been sent to the sink.
 389
 390
 391
 392
 393
 394
 395
 396
 397 <h3>Return value:</h3>
 398 Decoded data
 399
 400
 401
 402 </dd>
 403
 404
 405
 406
 407 <dt><a name="Decoder.sink"></a><strong>Decoder:sink</strong>&nbsp;()</dt>
 408 <dd>
 409
 410
 411 Create an LTN12 sink from the decoder object which accepts the JSON-Data.
 412
 413
 414
 415
 416
 417
 418
 419
 420 <h3>Return value:</h3>
 421 LTN12 sink
 422
 423
 424
 425 </dd>
 426
 427
 428
 429
 430 <dt><a name="Encoder"></a><strong>Encoder</strong>&nbsp;(data, buffersize, fastescape)</dt>
 431 <dd>
 432
 433
 434 Create a new JSON-Encoder.
 435
 436
 437
 438 <h3>Parameters</h3>
 439 <ul>
 440
 441         <li>
 442           data: Lua-Object to be encoded.
 443         </li>
 444
 445         <li>
 446           buffersize: Blocksize of returned data source.
 447         </li>
 448
 449         <li>
 450           fastescape: Use non-standard escaping (don't escape control chars)
 451         </li>
 452
 453 </ul>
 454
 455
 456
 457
 458
 459
 460 <h3>Return value:</h3>
 461 JSON-Encoder
 462
 463
 464
 465 </dd>
 466
 467
 468
 469
 470 <dt><a name="Encoder.source"></a><strong>Encoder:source</strong>&nbsp;()</dt>
 471 <dd>
 472
 473
 474 Create an LTN12 source providing the encoded JSON-Data.
 475
 476
 477
 478
 479
 480
 481
 482
 483 <h3>Return value:</h3>
 484 LTN12 source
 485
 486
 487
 488 </dd>
 489
 490
 491
 492
 493 <dt><a name="decode"></a><strong>decode</strong>&nbsp;(json)</dt>
 494 <dd>
 495
 496
 497 Directly decode a JSON string
 498
 499
 500
 501 <h3>Parameters</h3>
 502 <ul>
 503
 504         <li>
 505           json: JSON-String
 506         </li>
 507
 508 </ul>
 509
 510
 511
 512
 513
 514
 515 <h3>Return value:</h3>
 516 Lua object
 517
 518
 519
 520 </dd>
 521
 522
 523
 524
 525 <dt><a name="encode"></a><strong>encode</strong>&nbsp;(obj)</dt>
 526 <dd>
 527
 528
 529 Direcly encode a Lua object into a JSON string.
 530
 531
 532
 533 <h3>Parameters</h3>
 534 <ul>
 535
 536         <li>
 537           obj: Lua Object
 538         </li>
 539
 540 </ul>
 541
 542
 543
 544
 545
 546
 547 <h3>Return value:</h3>
 548 JSON string
 549
 550
 551
 552 </dd>
 553
 554
 555
 556
 557 <dt><a name="null"></a><strong>null</strong>&nbsp;()</dt>
 558 <dd>
 559
 560
 561 Null replacement function
 562
 563
 564
 565
 566
 567
 568
 569
 570 <h3>Return value:</h3>
 571 null
 572
 573
 574
 575 </dd>
 576
 577
 578 </dl>
 579
 580
 581
 582
 583
 584 </div> <!-- id="content" -->
 585
 586 </div> <!-- id="main" -->
 587
 588 <div id="about">
 589         <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>
 590 </div> <!-- id="about" -->
 591
 592 </div> <!-- id="container" -->
 593 </body>
 594 </html>