diff options
Diffstat (limited to 'docs/jsapi/LuCI.Network.Protocol.html')
| -rw-r--r-- | docs/jsapi/LuCI.Network.Protocol.html | 5394 |
1 files changed, 5394 insertions, 0 deletions
diff --git a/docs/jsapi/LuCI.Network.Protocol.html b/docs/jsapi/LuCI.Network.Protocol.html new file mode 100644 index 000000000..20239bce8 --- /dev/null +++ b/docs/jsapi/LuCI.Network.Protocol.html @@ -0,0 +1,5394 @@ +<!DOCTYPE html> +<html> +<head> + <meta charset="utf-8"> + <title>Class: Protocol</title> + + + <script src="scripts/prettify/prettify.js"></script> + <script src="scripts/prettify/lang-css.js"></script> + <script src="scripts/jquery.min.js"></script> + <!--[if lt IE 9]> + <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> + <![endif]--> + <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> + <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> + <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> + + + <script> + var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}}; + </script> + + + +</head> +<body> +<div id="wrap" class="clearfix"> + +<div class="navigation"> + <h3 class="applicationName"><a href="index.html"></a></h3> + + <div class="search"> + <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> + </div> + <ul class="list"> + + <li class="item" data-name="LuCI"> + <span class="title"> + <a href="LuCI.html">LuCI</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li> + + <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> + + <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> + + <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> + + <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> + + <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> + + <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> + + <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li> + + <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li> + + <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li> + + <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li> + + <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li> + + <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li> + + <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li> + + <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li> + + <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li> + + <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li> + + <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li> + + <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Class"> + <span class="title"> + <a href="LuCI.Class.html">LuCI.Class</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li> + + <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li> + + <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li> + + <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li> + + <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li> + + <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.dom"> + <span class="title"> + <a href="LuCI.dom.html">LuCI.dom</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li> + + <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li> + + <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li> + + <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li> + + <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li> + + <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li> + + <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li> + + <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li> + + <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li> + + <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li> + + <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li> + + <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.fs"> + <span class="title"> + <a href="LuCI.fs.html">LuCI.fs</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li> + + <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li> + + <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li> + + <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li> + + <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li> + + <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li> + + <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li> + + <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li> + + <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Headers"> + <span class="title"> + <a href="LuCI.Headers.html">LuCI.Headers</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li> + + <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network"> + <span class="title"> + <a href="LuCI.Network.html">LuCI.Network</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li> + + <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li> + + <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li> + + <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li> + + <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li> + + <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li> + + <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li> + + <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li> + + <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li> + + <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li> + + <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li> + + <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li> + + <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li> + + <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li> + + <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li> + + <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li> + + <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li> + + <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li> + + <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li> + + <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li> + + <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li> + + <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li> + + <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Device"> + <span class="title"> + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li> + + <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li> + + <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li> + + <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li> + + <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li> + + <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li> + + <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li> + + <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li> + + <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li> + + <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li> + + <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li> + + <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Hosts"> + <span class="title"> + <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li> + + <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.Protocol"> + <span class="title"> + <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li> + + <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li> + + <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li> + + <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li> + + <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li> + + <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li> + + <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li> + + <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li> + + <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li> + + <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li> + + <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li> + + <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li> + + <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li> + + <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li> + + <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li> + + <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li> + + <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li> + + <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li> + + <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li> + + <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li> + + <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li> + + <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li> + + <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li> + + <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li> + + <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li> + + <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li> + + <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li> + + <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiDevice"> + <span class="title"> + <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li> + + <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li> + + <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li> + + <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Network.WifiNetwork"> + <span class="title"> + <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li> + + <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li> + + <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li> + + <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Poll"> + <span class="title"> + <a href="LuCI.Poll.html">LuCI.Poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li> + + <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li> + + <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li> + + <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li> + + <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request"> + <span class="title"> + <a href="LuCI.Request.html">LuCI.Request</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li> + + <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li> + + <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li> + + <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Request.poll"> + <span class="title"> + <a href="LuCI.Request.poll.html">LuCI.Request.poll</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li> + + <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li> + + <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li> + + <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li> + + <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.Response"> + <span class="title"> + <a href="LuCI.Response.html">LuCI.Response</a> + + </span> + <ul class="members itemMembers"> + + <span class="subtitle">Members</span> + + <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li> + + <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li> + + <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li> + + <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li> + + <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li> + + <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li> + + <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li> + + <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.rpc"> + <span class="title"> + <a href="LuCI.rpc.html">LuCI.rpc</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li> + + <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li> + + <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li> + + <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li> + + <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li> + + <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li> + + <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li> + + <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li> + + <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li> + + <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li> + + <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li> + + <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.uci"> + <span class="title"> + <a href="LuCI.uci.html">LuCI.uci</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + <span class="subtitle">Typedefs</span> + + <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li> + + <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li> + + <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li> + + <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li> + + <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li> + + <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li> + + <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li> + + <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li> + + <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li> + + <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li> + + <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li> + + <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li> + + <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li> + + <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li> + + <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li> + + <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li> + + <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li> + + <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li> + + <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.view"> + <span class="title"> + <a href="LuCI.view.html">LuCI.view</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li> + + <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li> + + <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li> + + <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li> + + <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li> + + <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + <li class="item" data-name="LuCI.XHR"> + <span class="title"> + <a href="LuCI.XHR.html">LuCI.XHR</a> + + </span> + <ul class="members itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="typedefs itemMembers"> + + </ul> + <ul class="methods itemMembers"> + + <span class="subtitle">Methods</span> + + <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li> + + <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li> + + <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li> + + <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li> + + <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li> + + <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li> + + </ul> + <ul class="events itemMembers"> + + </ul> + </li> + + </ul> +</div> + <div class="main"> + <h1 class="page-title" data-filename="LuCI.Network.Protocol.html">Class: Protocol</h1> + + + + +<section> + +<header> + <h2> + <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span> + + Protocol + </h2> + + <div class="class-description"><p>The <code>Network.Protocol</code> class serves as base for protocol specific +subclasses which describe logical UCI networks defined by <code>config interface</code> sections in <code>/etc/config/network</code>.</p></div> + +</header> + +<article> + <div class="container-overview"> + + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="Protocol"> + + new LuCI.Network.Protocol<span class="signature">()</span> + </h4> + + + <div class="tag-source"> + network.js, line 1794 + </div> + + </div> + + +</dt> +<dd> + + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + +</dd> + + + </div> + + + + + + + + + + + + + + + <h3 class="subsection-title">Methods</h3> + + <dl> + +<dt> + <div class="nameContainer"> + <h4 class="name" id="addDevice"> + + addDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2383 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Add the given network device to the logical interface.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>device</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> +| + +<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span> +| + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + <p>The object or device name to add to the logical interface. In case the +given argument is not a string, it is resolved though the +<a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> if the device name has been added or <code>false</code> if any +argument was invalid, if the device was already part of the logical +interface or if the logical interface is virtual.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="containsDevice"> + + containsDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2552 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this logical interface contains the given device +object.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>device</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> +| + +<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span> +| + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + <p>The object or device name to check. In case the given argument is not +a string, it is resolved though the +<a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when this logical interface contains the given network +device or <code>false</code> if not.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="deleteDevice"> + + deleteDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2410 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Remove the given network device from the logical interface.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>device</code></td> + + + <td class="type"> + + +<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> +| + +<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> +| + +<span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span> +| + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + <p>The object or device name to remove from the logical interface. In case +the given argument is not a string, it is resolved though the +<a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> if the device name has been added or <code>false</code> if any +argument was invalid, if the device was already part of the logical +interface or if the logical interface is virtual.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="get"> + + get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1827 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Read the given UCI option value of this network.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>opt</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + <p>The UCI option name to read.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + | + + Array.<string> + + + </td> + <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is +not found.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevice"> + + getDevice<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2437 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Returns the Linux network device associated with this logical +interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the +expected Linux network device according to the configuration.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDevices"> + + getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2498 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Returns a list of network sub-devices associated with this logical +interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>> + + + </td> + <td class="description last">Returns an array of of <code>Network.Device</code> class instances representing +the sub-devices attached to this logical interface or <code>null</code> if the +logical interface does not support sub-devices, e.g. because it is +virtual and not a bridge.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDNS6Addrs"> + + getDNS6Addrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2152 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the IPv6 DNS servers associated with the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv6 DNS servers registered by the remote +protocol backend.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getDNSAddrs"> + + getDNSAddrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2064 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the IPv4 DNS servers associated with the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv4 DNS servers registered by the remote +protocol backend.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getErrors"> + + getErrors<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2196 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query interface error messages published in <code>ubus</code> runtime state.</p> +<p>Interface errors are emitted by remote protocol handlers if the setup +of the underlying logical interface failed, e.g. due to bad +configuration or network connectivity issues.</p> +<p>This function will translate the found error codes to human readable +messages using the descriptions registered by +<a href="LuCI.Network.html#registerErrorCode"><code>Network.registerErrorCode()</code></a> +and fall back to <code>"Unknown error (%s)"</code> where <code>%s</code> is replaced by the +error code in case no translation can be found.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of translated interface error messages.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getExpiry"> + + getExpiry<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1947 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the logical interface expiry time in seconds.</p> +<p>For protocols that have a concept of a lease, such as DHCP or +DHCPv6, this function returns the remaining time in seconds +until the lease expires.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the amount of seconds until the lease expires or <code>-1</code> +if it isn't applicable to the associated protocol.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getGateway6Addr"> + + getGateway6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2132 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the gateway (nexthop) of the IPv6 default route associated with +this logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string containing the IPv6 nexthop address of the associated +default route or <code>null</code> if no default route was found.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getGatewayAddr"> + + getGatewayAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2044 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the gateway (nexthop) of the default route associated with +this logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns a string containing the IPv4 nexthop address of the associated +default route or <code>null</code> if no default route was found.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getI18n"> + + <span class="type-signature ">abstract</span>getI18n<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1892 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Return a human readable description for the protcol, such as +<code>Static address</code> or <code>DHCP client</code>.</p> +<p>This function should be overwritten by subclasses.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the description string.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIfname"> + + getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1852 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the associared Linux network device of this network.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the associated network device or <code>null</code> if +it could not be determined.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Addr"> + + getIP6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2083 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the first (primary) IPv6 address of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the primary IPv6 address registered by the protocol handler +in CIDR notation or <code>null</code> if no IPv6 addresses were set.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Addrs"> + + getIP6Addrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2105 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query all IPv6 addresses of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv6 addresses in CIDR notation which have been +registered by the protocol handler. The order of the resulting array +follows the order of the addresses in <code>ubus</code> runtime information.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIP6Prefix"> + + getIP6Prefix<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2171 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the routed IPv6 prefix associated with the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the routed IPv6 prefix registered by the remote protocol +handler or <code>null</code> if no prefix is present.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddr"> + + getIPAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1999 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the first (primary) IPv4 address of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the primary IPv4 address registered by the protocol handler +or <code>null</code> if no IPv4 addresses were set.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getIPAddrs"> + + getIPAddrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<string>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2012 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query all IPv4 addresses of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + Array.<string> + + + </td> + <td class="description last">Returns an array of IPv4 addresses in CIDR notation which have been +registered by the protocol handler. The order of the resulting array +follows the order of the addresses in <code>ubus</code> runtime information.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getL2Device"> + + getL2Device<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2470 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Returns the layer 2 linux network device currently associated +with this logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux +network device currently associated with the logical interface.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getL3Device"> + + getL3Device<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2483 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Returns the layer 3 linux network device currently associated +with this logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> + + + </td> + <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux +network device currently associated with the logical interface.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getMetric"> + + getMetric<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1967 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the metric value of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the current metric value used for device and network +routes spawned by the associated logical interface.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getName"> + + getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1922 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the name of the associated logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the logical interface name, such as <code>lan</code> or <code>wan</code>.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getNetmask"> + + getNetmask<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2030 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Query the first (primary) IPv4 netmask of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the netmask of the primary IPv4 address registered by the +protocol handler or <code>null</code> if no IPv4 addresses were set.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getOpkgPackage"> + + <span class="type-signature ">abstract</span>getOpkgPackage<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2236 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the name of the opkg package providing the protocol functionality.</p> +<p>This function should be overwritten by protocol specific subclasses.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the name of the opkg package required for the protocol to +function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> prototocol.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getProtocol"> + + <span class="type-signature ">abstract</span>getProtocol<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1878 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the name of this network protocol class.</p> +<p>This function will be overwritten by subclasses created by +<a href="LuCI.Network.html#registerProtocol"><code>Network.registerProtocol()</code></a>.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + string + + + </td> + <td class="description last">Returns the name of the network protocol implementation, e.g. +<code>static</code> or <code>dhcp</code>.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getType"> + + getType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1912 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the type of the underlying interface.</p> +<p>This function actually is a convenience wrapper around +<code>proto.get("type")</code> and is mainly used by other <code>LuCI.Network</code> code +to check whether the interface is declared as bridge in UCI.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the value of the <code>type</code> option of the associated logical +interface or <code>null</code> if no <code>type</code> option is set.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getUptime"> + + getUptime<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1932 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the uptime of the logical interface.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + number + + + </td> + <td class="description last">Returns the uptime of the associated interface in seconds.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="getZoneName"> + + getZoneName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 1983 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Get the requested firewall zone name of the logical interface.</p> +<p>Some protocol implementations request a specific firewall zone +to trigger inclusion of their resulting network devices into the +firewall rule set.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the requested firewall zone name as published in the +<code>ubus</code> runtime information or <code>null</code> if the remote protocol +handler didn't request a zone.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isAlias"> + + isAlias<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2324 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this interface is an alias interface.</p> +<p>Alias interfaces are interfaces layering on top of another interface +and are denoted by a special <code>@interfacename</code> notation in the +underlying <code>ifname</code> option.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + null + | + + string + + + </td> + <td class="description last">Returns the name of the parent interface if this logical interface +is an alias or <code>null</code> if it is not an alias interface.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isBridge"> + + isBridge<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2221 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether the underlying logical interface is declared as bridge.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the interface is declared with <code>option type bridge</code> +and when the associated protocol implementation is not marked virtual +or <code>false</code> when the logical interface is no bridge.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isDynamic"> + + isDynamic<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2309 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this logical interface is dynamic.</p> +<p>A dynamic interface is an interface which has been created at runtime, +e.g. as sub-interface of another interface, but which is not backed by +any user configuration. Such dynamic interfaces cannot be edited but +only brought down or restarted.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether this interface is dynamic (<code>true</code>) +or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isEmpty"> + + isEmpty<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2344 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this logical interface is "empty", meaning that ut +has no network devices attached.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> if this logical interface is empty, else <code>false</code>.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isFloating"> + + isFloating<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2293 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this protocol is "floating".</p> +<p>A "floating" protocol is a protocol which spawns its own interfaces +on demand, like a virtual one but which relies on an existinf lower +level interface to initiate the connection.</p> +<p>An example for such a protocol is "pppoe".</p> +<p>This function exists for backwards compatibility with older code +but should not be used anymore.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether this protocol is floating (<code>true</code>) +or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isInstalled"> + + <span class="type-signature ">abstract</span>isInstalled<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2252 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether the protocol functionality is installed.</p> +<p>This function exists for compatibility with old code, it always +returns <code>true</code>.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd> + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> if the protocol support is installed, else <code>false</code>.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isUp"> + + isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2366 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this logical interface is configured and running.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns <code>true</code> when the interface is active or <code>false</code> when it is not.</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="isVirtual"> + + isVirtual<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> + </h4> + + + <div class="tag-source"> + network.js, line 2272 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Checks whether this protocol is "virtual".</p> +<p>A "virtual" protocol is a protocol which spawns its own interfaces +on demand instead of using existing physical interfaces.</p> +<p>Examples for virtual protocols are <code>6in4</code> which <code>gre</code> spawn tunnel +network device on startup, examples for non-virtual protcols are +<code>dhcp</code> or <code>static</code> which apply IP configuration to existing interfaces.</p> +<p>This function should be overwritten by subclasses.</p> + </div> + + + + + + + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + <h5>Returns:</h5> + + + +<table class="params"> + <thead> + <tr> + + <th>Type</th> + <th class="last">Description</th> + </tr> + </thead> + <tbody> + + <tr> + + <td class="type"> + + boolean + + + </td> + <td class="description last">Returns a boolean indicating whether the underlying protocol spawns +dynamic interfaces (<code>true</code>) or not (<code>false</code>).</td> + </tr> + + </tbody> +</table> + + + + +</dd> + + + +<dt> + <div class="nameContainer"> + <h4 class="name" id="set"> + + set<span class="signature">(opt, val)</span> + </h4> + + + <div class="tag-source"> + network.js, line 1841 + </div> + + </div> + + +</dt> +<dd> + + + <div class="description"> + <p>Set the given UCI option of this network to the given value.</p> + </div> + + + + + + + + + +<table class="params"> + <thead> + <tr> + + <th>Name</th> + + + <th>Type</th> + + + + <th class="last">Description</th> + </tr> + </thead> + + <tbody> + + + <tr> + + <td class="name"><code>opt</code></td> + + + <td class="type"> + + +<span class="param-type">string</span> + + + + </td> + + + + <td class="description last"> + + <p>The name of the UCI option to set.</p></td> + </tr> + + + + <tr> + + <td class="name"><code>val</code></td> + + + <td class="type"> + + +<span class="param-type">null</span> +| + +<span class="param-type">string</span> +| + +<span class="param-type">Array.<string></span> + + + + </td> + + + + <td class="description last"> + + <p>The value to set or <code>null</code> to remove the given option from the +configuration.</p></td> + </tr> + + + </tbody> +</table> + + + +<dl class="details"> + + + + + + + + + + + + + + + + + + + + + +</dl> + + + + + + + + + + + + + +</dd> + + </dl> + + + + + + + +</article> + +</section> + + + + + + + + <footer> + Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) + </footer> + </div> +</div> +<script>prettyPrint();</script> +<script src="scripts/jaguar.js"></script> +</body> +</html>
\ No newline at end of file |