documentation/api/modules/luci.sys.iptparser.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.protocol.html">luci.http.protocol</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.html">luci.ip</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.json.html">luci.json</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.html">luci.sys</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 107         </li>
 108
 109         <li><strong>luci.sys.iptparser</strong></li>
 110
 111         <li>
 112                 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
 113         </li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.util.html">luci.util</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Object Instance <code>luci.sys.iptparser</code></h1>
 200
 201 <p></p>
 202
 203
 204
 205
 206
 207
 208
 209 <h2>Functions</h2>
 210 <table class="function_list">
 211
 212         <tr>
 213         <td class="name" nowrap><a href="#IptParser">IptParser</a>&nbsp;(family)</td>
 214         <td class="summary">
 215
 216 Create a new iptables parser object.</td>
 217         </tr>
 218
 219         <tr>
 220         <td class="name" nowrap><a href="#IptParser.chain">IptParser:chain</a>&nbsp;(table, chain)</td>
 221         <td class="summary">
 222
 223 Return the given firewall chain within the given table name.</td>
 224         </tr>
 225
 226         <tr>
 227         <td class="name" nowrap><a href="#IptParser.chains">IptParser:chains</a>&nbsp;(table)</td>
 228         <td class="summary">
 229
 230 Find the names of all chains within the given table name.</td>
 231         </tr>
 232
 233         <tr>
 234         <td class="name" nowrap><a href="#IptParser.is_custom_target">IptParser:is_custom_target</a>&nbsp;(target)</td>
 235         <td class="summary">
 236
 237 Test whether the given target points to a custom chain.</td>
 238         </tr>
 239
 240         <tr>
 241         <td class="name" nowrap><a href="#IptParser.resync">IptParser:resync</a>&nbsp;()</td>
 242         <td class="summary">
 243
 244 Rebuild the internal lookup table, for example when rules have changed
 245
 246 through external commands.</td>
 247         </tr>
 248
 249         <tr>
 250         <td class="name" nowrap><a href="#IptParser.tables">IptParser:tables</a>&nbsp;()</td>
 251         <td class="summary">
 252
 253 Find the names of all tables.</td>
 254         </tr>
 255
 256 </table>
 257
 258
 259
 260
 261
 262
 263 <br/>
 264 <br/>
 265
 266
 267 <h2><a name="functions"></a>Functions</h2>
 268 <dl class="function">
 269
 270
 271
 272 <dt><a name="IptParser"></a><strong>IptParser</strong>&nbsp;(family)</dt>
 273 <dd>
 274
 275
 276 Create a new iptables parser object.
 277
 278
 279
 280 <h3>Parameters</h3>
 281 <ul>
 282
 283         <li>
 284           family: Number specifying the address family. 4 for IPv4, 6 for IPv6
 285         </li>
 286
 287 </ul>
 288
 289
 290
 291
 292
 293
 294 <h3>Return value:</h3>
 295 IptParser instance
 296
 297
 298
 299 </dd>
 300
 301
 302
 303
 304 <dt><a name="IptParser.chain"></a><strong>IptParser:chain</strong>&nbsp;(table, chain)</dt>
 305 <dd>
 306
 307
 308 Return the given firewall chain within the given table name.
 309
 310
 311
 312 <h3>Parameters</h3>
 313 <ul>
 314
 315         <li>
 316           table: String containing the table name
 317         </li>
 318
 319         <li>
 320           chain: String containing the chain name
 321         </li>
 322
 323 </ul>
 324
 325
 326
 327
 328
 329
 330 <h3>Return value:</h3>
 331 Table containing the fields "policy", "packets", "bytes"
 332                                 and "rules". The "rules" field is a table of rule tables.
 333
 334
 335
 336 </dd>
 337
 338
 339
 340
 341 <dt><a name="IptParser.chains"></a><strong>IptParser:chains</strong>&nbsp;(table)</dt>
 342 <dd>
 343
 344
 345 Find the names of all chains within the given table name.
 346
 347
 348
 349 <h3>Parameters</h3>
 350 <ul>
 351
 352         <li>
 353           table: String containing the table name
 354         </li>
 355
 356 </ul>
 357
 358
 359
 360
 361
 362
 363 <h3>Return value:</h3>
 364 Table of chain names in the order they occur.
 365
 366
 367
 368 </dd>
 369
 370
 371
 372
 373 <dt><a name="IptParser.is_custom_target"></a><strong>IptParser:is_custom_target</strong>&nbsp;(target)</dt>
 374 <dd>
 375
 376
 377 Test whether the given target points to a custom chain.
 378
 379
 380
 381 <h3>Parameters</h3>
 382 <ul>
 383
 384         <li>
 385           target: String containing the target action
 386         </li>
 387
 388 </ul>
 389
 390
 391
 392
 393
 394
 395 <h3>Return value:</h3>
 396 Boolean indicating whether target is a custom chain.
 397
 398
 399
 400 </dd>
 401
 402
 403
 404
 405 <dt><a name="IptParser.resync"></a><strong>IptParser:resync</strong>&nbsp;()</dt>
 406 <dd>
 407
 408
 409 Rebuild the internal lookup table, for example when rules have changed
 410
 411 through external commands.
 412
 413
 414
 415
 416
 417
 418
 419 <h3>Return value:</h3>
 420 nothing
 421
 422
 423
 424 </dd>
 425
 426
 427
 428
 429 <dt><a name="IptParser.tables"></a><strong>IptParser:tables</strong>&nbsp;()</dt>
 430 <dd>
 431
 432
 433 Find the names of all tables.
 434
 435
 436
 437
 438
 439
 440
 441
 442 <h3>Return value:</h3>
 443 Table of table names.
 444
 445
 446
 447 </dd>
 448
 449
 450 </dl>
 451
 452
 453
 454
 455
 456 </div> <!-- id="content" -->
 457
 458 </div> <!-- id="main" -->
 459
 460 <div id="about">
 461         <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>
 462 </div> <!-- id="about" -->
 463
 464 </div> <!-- id="container" -->
 465 </body>
 466 </html>