123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
- <html>
- <head>
- <title>Reference</title>
- <link rel="stylesheet" href="../luadoc.css" type="text/css" />
- <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
- </head>
- <body>
- <div id="container">
- <div id="product">
- <div id="product_logo"></div>
- <div id="product_name"><big><b></b></big></div>
- <div id="product_description"></div>
- </div> <!-- id="product" -->
- <div id="main">
- <div id="navigation">
- <h1>LuaDoc</h1>
- <ul>
-
- <li><a href="../index.html">Index</a></li>
-
- </ul>
- <!-- Module list -->
- <h1>Modules</h1>
- <ul>
- <li>
- <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
- </li>
- <li>
- <a href="../modules/luci.http.html">luci.http</a>
- </li>
- <li>
- <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
- </li>
- <li>
- <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
- </li>
- <li>
- <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
- </li>
- <li>
- <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
- </li>
- <li>
- <a href="../modules/luci.i18n.html">luci.i18n</a>
- </li>
- <li>
- <a href="../modules/luci.ip.html">luci.ip</a>
- </li>
- <li>
- <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
- </li>
- <li>
- <a href="../modules/luci.json.html">luci.json</a>
- </li>
- <li>
- <a href="../modules/luci.jsonc.html">luci.jsonc</a>
- </li>
- <li>
- <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
- </li>
- <li>
- <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
- </li>
- <li>
- <a href="../modules/luci.model.uci.html">luci.model.uci</a>
- </li>
- <li>
- <a href="../modules/luci.rpcc.html">luci.rpcc</a>
- </li>
- <li>
- <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
- </li>
- <li>
- <a href="../modules/luci.sys.html">luci.sys</a>
- </li>
- <li>
- <a href="../modules/luci.sys.init.html">luci.sys.init</a>
- </li>
- <li>
- <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
- </li>
- <li><strong>luci.sys.net</strong></li>
-
- <li>
- <a href="../modules/luci.sys.process.html">luci.sys.process</a>
- </li>
- <li>
- <a href="../modules/luci.sys.user.html">luci.sys.user</a>
- </li>
- <li>
- <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
- </li>
- <li>
- <a href="../modules/luci.util.html">luci.util</a>
- </li>
- <li>
- <a href="../modules/nixio.html">nixio</a>
- </li>
- <li>
- <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
- </li>
- <li>
- <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
- </li>
- <li>
- <a href="../modules/nixio.File.html">nixio.File</a>
- </li>
- <li>
- <a href="../modules/nixio.README.html">nixio.README</a>
- </li>
- <li>
- <a href="../modules/nixio.Socket.html">nixio.Socket</a>
- </li>
- <li>
- <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
- </li>
- <li>
- <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
- </li>
- <li>
- <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
- </li>
- <li>
- <a href="../modules/nixio.bin.html">nixio.bin</a>
- </li>
- <li>
- <a href="../modules/nixio.bit.html">nixio.bit</a>
- </li>
- <li>
- <a href="../modules/nixio.crypto.html">nixio.crypto</a>
- </li>
- <li>
- <a href="../modules/nixio.fs.html">nixio.fs</a>
- </li>
- </ul>
- <!-- File list -->
- </div><!-- id="navigation" -->
- <div id="content">
- <h1>Class <code>luci.sys.net</code></h1>
- <p>
-
- LuCI system utilities / network related functions.
- </p>
- <h2>Functions</h2>
- <table class="function_list">
- <tr>
- <td class="name" nowrap><a href="#net.arptable">arptable</a> ()</td>
- <td class="summary">
-
- Returns the current arp-table entries as two-dimensional table.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.conntrack">conntrack</a> ()</td>
- <td class="summary">
-
- Returns conntrack information
- </td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.deviceinfo">deviceinfo</a> ()</td>
- <td class="summary">
-
- Return information about available network interfaces.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.devices">devices</a> ()</td>
- <td class="summary">
-
- Determine the names of available network interfaces.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.host_hints">host_hints</a> ()</td>
- <td class="summary">
-
- Returns a two-dimensional table of host hints.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.ipv4_hints">ipv4_hints</a> ()</td>
- <td class="summary">
-
- Returns a two-dimensional table of IPv4 address hints.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.ipv6_hints">ipv6_hints</a> ()</td>
- <td class="summary">
-
- Returns a two-dimensional table of IPv6 address hints.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.mac_hints">mac_hints</a> ()</td>
- <td class="summary">
-
- Returns a two-dimensional table of mac address hints.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.pingtest">pingtest</a> (host)</td>
- <td class="summary">
-
- Tests whether the given host responds to ping probes.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.routes">routes</a> ()</td>
- <td class="summary">
-
- Returns the current kernel routing table entries.</td>
- </tr>
- <tr>
- <td class="name" nowrap><a href="#net.routes6">routes6</a> ()</td>
- <td class="summary">
-
- Returns the current ipv6 kernel routing table entries.</td>
- </tr>
- </table>
- <br/>
- <br/>
- <h2><a name="functions"></a>Functions</h2>
- <dl class="function">
- <dt><a name="net.arptable"></a><strong>arptable</strong> ()</dt>
- <dd>
-
- Returns the current arp-table entries as two-dimensional table.
- <h3>Return value:</h3>
- Table of table containing the current arp entries.
- The following fields are defined for arp entry objects:
- { "IP address", "HW address", "HW type", "Flags", "Mask", "Device" }
- </dd>
- <dt><a name="net.conntrack"></a><strong>conntrack</strong> ()</dt>
- <dd>
-
- Returns conntrack information
- <h3>Return value:</h3>
- Table with the currently tracked IP connections
- </dd>
- <dt><a name="net.deviceinfo"></a><strong>deviceinfo</strong> ()</dt>
- <dd>
-
- Return information about available network interfaces.
- <h3>Return value:</h3>
- Table containing all current interface names and their information
- </dd>
- <dt><a name="net.devices"></a><strong>devices</strong> ()</dt>
- <dd>
-
- Determine the names of available network interfaces.
- <h3>Return value:</h3>
- Table containing all current interface names
- </dd>
- <dt><a name="net.host_hints"></a><strong>host_hints</strong> ()</dt>
- <dd>
-
- Returns a two-dimensional table of host hints.
- <h3>Return value:</h3>
- Table of table containing known hosts from various sources,
- indexed by mac address. Each subtable contains at least one
- of the fields "name", "ipv4" or "ipv6".
- </dd>
- <dt><a name="net.ipv4_hints"></a><strong>ipv4_hints</strong> ()</dt>
- <dd>
-
- Returns a two-dimensional table of IPv4 address hints.
- <h3>Return value:</h3>
- Table of table containing known hosts from various sources.
- Each entry contains the values in the following order:
- [ "ip", "name" ]
- </dd>
- <dt><a name="net.ipv6_hints"></a><strong>ipv6_hints</strong> ()</dt>
- <dd>
-
- Returns a two-dimensional table of IPv6 address hints.
- <h3>Return value:</h3>
- Table of table containing known hosts from various sources.
- Each entry contains the values in the following order:
- [ "ip", "name" ]
- </dd>
- <dt><a name="net.mac_hints"></a><strong>mac_hints</strong> ()</dt>
- <dd>
-
- Returns a two-dimensional table of mac address hints.
- <h3>Return value:</h3>
- Table of table containing known hosts from various sources.
- Each entry contains the values in the following order:
- [ "mac", "name" ]
- </dd>
- <dt><a name="net.pingtest"></a><strong>pingtest</strong> (host)</dt>
- <dd>
-
- Tests whether the given host responds to ping probes.
- <h3>Parameters</h3>
- <ul>
-
- <li>
- host: String containing a hostname or IPv4 address
- </li>
-
- </ul>
- <h3>Return value:</h3>
- Number containing 0 on success and >= 1 on error
- </dd>
- <dt><a name="net.routes"></a><strong>routes</strong> ()</dt>
- <dd>
-
- Returns the current kernel routing table entries.
- <h3>Return value:</h3>
- Table of tables with properties of the corresponding routes.
- The following fields are defined for route entry tables:
- { "dest", "gateway", "metric", "refcount", "usecount", "irtt",
- "flags", "device" }
- </dd>
- <dt><a name="net.routes6"></a><strong>routes6</strong> ()</dt>
- <dd>
-
- Returns the current ipv6 kernel routing table entries.
- <h3>Return value:</h3>
- Table of tables with properties of the corresponding routes.
- The following fields are defined for route entry tables:
- { "source", "dest", "nexthop", "metric", "refcount", "usecount",
- "flags", "device" }
- </dd>
- </dl>
- </div> <!-- id="content" -->
- </div> <!-- id="main" -->
- <div id="about">
- <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>
- </div> <!-- id="about" -->
- </div> <!-- id="container" -->
- </body>
- </html>
|