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.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>
  70                 <a href="../modules/luci.json.html">luci.json</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.sys.html">luci.sys</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 103         </li>
 104
 105         <li><strong>luci.sys.iptparser</strong></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.sys.iptparser</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="#IptParser">IptParser</a>&nbsp;(family)</td>
 210         <td class="summary">
 211
 212 Create a new iptables parser object.</td>
 213         </tr>
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#IptParser.chain">IptParser:chain</a>&nbsp;(table, chain)</td>
 217         <td class="summary">
 218
 219 Return the given firewall chain within the given table name.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#IptParser.chains">IptParser:chains</a>&nbsp;(table)</td>
 224         <td class="summary">
 225
 226 Find the names of all chains within the given table name.</td>
 227         </tr>
 228
 229         <tr>
 230         <td class="name" nowrap><a href="#IptParser.is_custom_target">IptParser:is_custom_target</a>&nbsp;(target)</td>
 231         <td class="summary">
 232
 233 Test whether the given target points to a custom chain.</td>
 234         </tr>
 235
 236         <tr>
 237         <td class="name" nowrap><a href="#IptParser.resync">IptParser:resync</a>&nbsp;()</td>
 238         <td class="summary">
 239
 240 Rebuild the internal lookup table, for example when rules have changed
 241
 242 through external commands.</td>
 243         </tr>
 244
 245         <tr>
 246         <td class="name" nowrap><a href="#IptParser.tables">IptParser:tables</a>&nbsp;()</td>
 247         <td class="summary">
 248
 249 Find the names of all tables.</td>
 250         </tr>
 251
 252 </table>
 253
 254
 255
 256
 257
 258
 259 <br/>
 260 <br/>
 261
 262
 263 <h2><a name="functions"></a>Functions</h2>
 264 <dl class="function">
 265
 266
 267
 268 <dt><a name="IptParser"></a><strong>IptParser</strong>&nbsp;(family)</dt>
 269 <dd>
 270
 271
 272 Create a new iptables parser object.
 273
 274
 275
 276 <h3>Parameters</h3>
 277 <ul>
 278
 279         <li>
 280           family: Number specifying the address family. 4 for IPv4, 6 for IPv6
 281         </li>
 282
 283 </ul>
 284
 285
 286
 287
 288
 289
 290 <h3>Return value:</h3>
 291 IptParser instance
 292
 293
 294
 295 </dd>
 296
 297
 298
 299
 300 <dt><a name="IptParser.chain"></a><strong>IptParser:chain</strong>&nbsp;(table, chain)</dt>
 301 <dd>
 302
 303
 304 Return the given firewall chain within the given table name.
 305
 306
 307
 308 <h3>Parameters</h3>
 309 <ul>
 310
 311         <li>
 312           table: String containing the table name
 313         </li>
 314
 315         <li>
 316           chain: String containing the chain name
 317         </li>
 318
 319 </ul>
 320
 321
 322
 323
 324
 325
 326 <h3>Return value:</h3>
 327 Table containing the fields "policy", "packets", "bytes"
 328                                 and "rules". The "rules" field is a table of rule tables.
 329
 330
 331
 332 </dd>
 333
 334
 335
 336
 337 <dt><a name="IptParser.chains"></a><strong>IptParser:chains</strong>&nbsp;(table)</dt>
 338 <dd>
 339
 340
 341 Find the names of all chains within the given table name.
 342
 343
 344
 345 <h3>Parameters</h3>
 346 <ul>
 347
 348         <li>
 349           table: String containing the table name
 350         </li>
 351
 352 </ul>
 353
 354
 355
 356
 357
 358
 359 <h3>Return value:</h3>
 360 Table of chain names in the order they occur.
 361
 362
 363
 364 </dd>
 365
 366
 367
 368
 369 <dt><a name="IptParser.is_custom_target"></a><strong>IptParser:is_custom_target</strong>&nbsp;(target)</dt>
 370 <dd>
 371
 372
 373 Test whether the given target points to a custom chain.
 374
 375
 376
 377 <h3>Parameters</h3>
 378 <ul>
 379
 380         <li>
 381           target: String containing the target action
 382         </li>
 383
 384 </ul>
 385
 386
 387
 388
 389
 390
 391 <h3>Return value:</h3>
 392 Boolean indicating whether target is a custom chain.
 393
 394
 395
 396 </dd>
 397
 398
 399
 400
 401 <dt><a name="IptParser.resync"></a><strong>IptParser:resync</strong>&nbsp;()</dt>
 402 <dd>
 403
 404
 405 Rebuild the internal lookup table, for example when rules have changed
 406
 407 through external commands.
 408
 409
 410
 411
 412
 413
 414
 415 <h3>Return value:</h3>
 416 nothing
 417
 418
 419
 420 </dd>
 421
 422
 423
 424
 425 <dt><a name="IptParser.tables"></a><strong>IptParser:tables</strong>&nbsp;()</dt>
 426 <dd>
 427
 428
 429 Find the names of all tables.
 430
 431
 432
 433
 434
 435
 436
 437
 438 <h3>Return value:</h3>
 439 Table of table names.
 440
 441
 442
 443 </dd>
 444
 445
 446 </dl>
 447
 448
 449
 450
 451
 452 </div> <!-- id="content" -->
 453
 454 </div> <!-- id="main" -->
 455
 456 <div id="about">
 457         <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>
 458 </div> <!-- id="about" -->
 459
 460 </div> <!-- id="container" -->
 461 </body>
 462 </html>