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