docs/jsapi/LuCI.Network.Protocol.html

   1 <!DOCTYPE html>
   2 <html>
   3 <head>
   4     <meta charset="utf-8">
   5     <title>Class: Protocol</title>
   6
   7
   8     <script src="scripts/prettify/prettify.js"></script>
   9     <script src="scripts/prettify/lang-css.js"></script>
  10     <script src="scripts/jquery.min.js"></script>
  11     <!--[if lt IE 9]>
  12       <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  13     <![endif]-->
  14     <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  15     <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css">
  16     <link type="text/css" rel="stylesheet" href="styles/jaguar.css">
  17
  18
  19     <script>
  20     var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
  21     </script>
  22
  23
  24
  25 </head>
  26 <body>
  27 <div id="wrap" class="clearfix">
  28
  29 <div class="navigation">
  30     <h3 class="applicationName"><a href="index.html"></a></h3>
  31
  32     <div class="search">
  33         <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
  34     </div>
  35     <ul class="list">
  36
  37         <li class="item" data-name="LuCI">
  38             <span class="title">
  39                 <a href="LuCI.html">LuCI</a>
  40
  41             </span>
  42             <ul class="members itemMembers">
  43
  44             <span class="subtitle">Members</span>
  45
  46                 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
  47
  48             </ul>
  49             <ul class="typedefs itemMembers">
  50
  51             <span class="subtitle">Typedefs</span>
  52
  53                 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
  54
  55             </ul>
  56             <ul class="typedefs itemMembers">
  57
  58             </ul>
  59             <ul class="methods itemMembers">
  60
  61             <span class="subtitle">Methods</span>
  62
  63                 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
  64
  65                 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
  66
  67                 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
  68
  69                 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
  70
  71                 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
  72
  73                 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
  74
  75                 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
  76
  77                 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
  78
  79                 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
  80
  81                 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
  82
  83                 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
  84
  85                 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
  86
  87                 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
  88
  89                 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
  90
  91                 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
  92
  93                 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
  94
  95                 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
  96
  97                 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
  98
  99                 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
 100
 101             </ul>
 102             <ul class="events itemMembers">
 103
 104             </ul>
 105         </li>
 106
 107         <li class="item" data-name="LuCI.Class">
 108             <span class="title">
 109                 <a href="LuCI.Class.html">LuCI.Class</a>
 110
 111             </span>
 112             <ul class="members itemMembers">
 113
 114             </ul>
 115             <ul class="typedefs itemMembers">
 116
 117             </ul>
 118             <ul class="typedefs itemMembers">
 119
 120             </ul>
 121             <ul class="methods itemMembers">
 122
 123             <span class="subtitle">Methods</span>
 124
 125                 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
 126
 127                 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
 128
 129                 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
 130
 131                 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
 132
 133                 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
 134
 135                 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
 136
 137             </ul>
 138             <ul class="events itemMembers">
 139
 140             </ul>
 141         </li>
 142
 143         <li class="item" data-name="LuCI.dom">
 144             <span class="title">
 145                 <a href="LuCI.dom.html">LuCI.dom</a>
 146
 147             </span>
 148             <ul class="members itemMembers">
 149
 150             </ul>
 151             <ul class="typedefs itemMembers">
 152
 153             <span class="subtitle">Typedefs</span>
 154
 155                 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
 156
 157             </ul>
 158             <ul class="typedefs itemMembers">
 159
 160             </ul>
 161             <ul class="methods itemMembers">
 162
 163             <span class="subtitle">Methods</span>
 164
 165                 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
 166
 167                 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
 168
 169                 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
 170
 171                 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
 172
 173                 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
 174
 175                 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
 176
 177                 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
 178
 179                 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
 180
 181                 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
 182
 183                 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
 184
 185                 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
 186
 187                 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
 188
 189                 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
 190
 191             </ul>
 192             <ul class="events itemMembers">
 193
 194             </ul>
 195         </li>
 196
 197         <li class="item" data-name="LuCI.fs">
 198             <span class="title">
 199                 <a href="LuCI.fs.html">LuCI.fs</a>
 200
 201             </span>
 202             <ul class="members itemMembers">
 203
 204             </ul>
 205             <ul class="typedefs itemMembers">
 206
 207             <span class="subtitle">Typedefs</span>
 208
 209                 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
 210
 211                 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
 212
 213             </ul>
 214             <ul class="typedefs itemMembers">
 215
 216             </ul>
 217             <ul class="methods itemMembers">
 218
 219             <span class="subtitle">Methods</span>
 220
 221                 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
 222
 223                 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
 224
 225                 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
 226
 227                 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
 228
 229                 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
 230
 231                 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
 232
 233                 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
 234
 235                 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
 236
 237             </ul>
 238             <ul class="events itemMembers">
 239
 240             </ul>
 241         </li>
 242
 243         <li class="item" data-name="LuCI.Headers">
 244             <span class="title">
 245                 <a href="LuCI.Headers.html">LuCI.Headers</a>
 246
 247             </span>
 248             <ul class="members itemMembers">
 249
 250             </ul>
 251             <ul class="typedefs itemMembers">
 252
 253             </ul>
 254             <ul class="typedefs itemMembers">
 255
 256             </ul>
 257             <ul class="methods itemMembers">
 258
 259             <span class="subtitle">Methods</span>
 260
 261                 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
 262
 263                 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
 264
 265             </ul>
 266             <ul class="events itemMembers">
 267
 268             </ul>
 269         </li>
 270
 271         <li class="item" data-name="LuCI.Network">
 272             <span class="title">
 273                 <a href="LuCI.Network.html">LuCI.Network</a>
 274
 275             </span>
 276             <ul class="members itemMembers">
 277
 278             </ul>
 279             <ul class="typedefs itemMembers">
 280
 281             <span class="subtitle">Typedefs</span>
 282
 283                 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
 284
 285                 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
 286
 287                 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
 288
 289                 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
 290
 291                 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
 292
 293             </ul>
 294             <ul class="typedefs itemMembers">
 295
 296             </ul>
 297             <ul class="methods itemMembers">
 298
 299             <span class="subtitle">Methods</span>
 300
 301                 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
 302
 303                 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
 304
 305                 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
 306
 307                 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 308
 309                 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
 310
 311                 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
 312
 313                 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
 314
 315                 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
 316
 317                 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
 318
 319                 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
 320
 321                 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
 322
 323                 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
 324
 325                 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
 326
 327                 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
 328
 329                 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
 330
 331                 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
 332
 333                 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
 334
 335                 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
 336
 337                 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
 338
 339                 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
 340
 341                 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
 342
 343                 <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li>
 344
 345                 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
 346
 347                 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
 348
 349                 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
 350
 351                 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
 352
 353                 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
 354
 355                 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
 356
 357                 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
 358
 359             </ul>
 360             <ul class="events itemMembers">
 361
 362             </ul>
 363         </li>
 364
 365         <li class="item" data-name="LuCI.Network.Device">
 366             <span class="title">
 367                 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
 368
 369             </span>
 370             <ul class="members itemMembers">
 371
 372             </ul>
 373             <ul class="typedefs itemMembers">
 374
 375             </ul>
 376             <ul class="typedefs itemMembers">
 377
 378             </ul>
 379             <ul class="methods itemMembers">
 380
 381             <span class="subtitle">Methods</span>
 382
 383                 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
 384
 385                 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
 386
 387                 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
 388
 389                 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
 390
 391                 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
 392
 393                 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
 394
 395                 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
 396
 397                 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
 398
 399                 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
 400
 401                 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
 402
 403                 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
 404
 405                 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
 406
 407                 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
 408
 409                 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
 410
 411                 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
 412
 413                 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
 414
 415                 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
 416
 417                 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
 418
 419                 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
 420
 421                 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
 422
 423                 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
 424
 425                 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
 426
 427             </ul>
 428             <ul class="events itemMembers">
 429
 430             </ul>
 431         </li>
 432
 433         <li class="item" data-name="LuCI.Network.Hosts">
 434             <span class="title">
 435                 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
 436
 437             </span>
 438             <ul class="members itemMembers">
 439
 440             </ul>
 441             <ul class="typedefs itemMembers">
 442
 443             </ul>
 444             <ul class="typedefs itemMembers">
 445
 446             </ul>
 447             <ul class="methods itemMembers">
 448
 449             <span class="subtitle">Methods</span>
 450
 451                 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
 452
 453                 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
 454
 455                 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
 456
 457                 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
 458
 459                 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
 460
 461                 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
 462
 463                 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
 464
 465                 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
 466
 467             </ul>
 468             <ul class="events itemMembers">
 469
 470             </ul>
 471         </li>
 472
 473         <li class="item" data-name="LuCI.Network.Protocol">
 474             <span class="title">
 475                 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
 476
 477             </span>
 478             <ul class="members itemMembers">
 479
 480             </ul>
 481             <ul class="typedefs itemMembers">
 482
 483             </ul>
 484             <ul class="typedefs itemMembers">
 485
 486             </ul>
 487             <ul class="methods itemMembers">
 488
 489             <span class="subtitle">Methods</span>
 490
 491                 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
 492
 493                 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
 494
 495                 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
 496
 497                 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
 498
 499                 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
 500
 501                 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
 502
 503                 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
 504
 505                 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
 506
 507                 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
 508
 509                 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
 510
 511                 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
 512
 513                 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
 514
 515                 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
 516
 517                 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
 518
 519                 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
 520
 521                 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
 522
 523                 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
 524
 525                 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
 526
 527                 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
 528
 529                 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
 530
 531                 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
 532
 533                 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
 534
 535                 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
 536
 537                 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
 538
 539                 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
 540
 541                 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
 542
 543                 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
 544
 545                 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
 546
 547                 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
 548
 549                 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
 550
 551                 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
 552
 553                 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
 554
 555                 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
 556
 557                 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
 558
 559                 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
 560
 561                 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
 562
 563                 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
 564
 565                 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
 566
 567             </ul>
 568             <ul class="events itemMembers">
 569
 570             </ul>
 571         </li>
 572
 573         <li class="item" data-name="LuCI.Network.WifiDevice">
 574             <span class="title">
 575                 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
 576
 577             </span>
 578             <ul class="members itemMembers">
 579
 580             </ul>
 581             <ul class="typedefs itemMembers">
 582
 583             </ul>
 584             <ul class="typedefs itemMembers">
 585
 586             </ul>
 587             <ul class="methods itemMembers">
 588
 589             <span class="subtitle">Methods</span>
 590
 591                 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
 592
 593                 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
 594
 595                 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
 596
 597                 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
 598
 599                 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
 600
 601                 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
 602
 603                 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
 604
 605                 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
 606
 607                 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
 608
 609                 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
 610
 611                 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
 612
 613                 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
 614
 615                 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
 616
 617             </ul>
 618             <ul class="events itemMembers">
 619
 620             </ul>
 621         </li>
 622
 623         <li class="item" data-name="LuCI.Network.WifiNetwork">
 624             <span class="title">
 625                 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
 626
 627             </span>
 628             <ul class="members itemMembers">
 629
 630             </ul>
 631             <ul class="typedefs itemMembers">
 632
 633             </ul>
 634             <ul class="typedefs itemMembers">
 635
 636             </ul>
 637             <ul class="methods itemMembers">
 638
 639             <span class="subtitle">Methods</span>
 640
 641                 <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li>
 642
 643                 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
 644
 645                 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
 646
 647                 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
 648
 649                 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
 650
 651                 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
 652
 653                 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
 654
 655                 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
 656
 657                 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
 658
 659                 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
 660
 661                 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
 662
 663                 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
 664
 665                 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
 666
 667                 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
 668
 669                 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
 670
 671                 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
 672
 673                 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
 674
 675                 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
 676
 677                 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
 678
 679                 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
 680
 681                 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
 682
 683                 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
 684
 685                 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
 686
 687                 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
 688
 689                 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
 690
 691                 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
 692
 693                 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
 694
 695                 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
 696
 697                 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
 698
 699                 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
 700
 701                 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
 702
 703                 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
 704
 705                 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
 706
 707                 <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li>
 708
 709                 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
 710
 711                 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
 712
 713                 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
 714
 715             </ul>
 716             <ul class="events itemMembers">
 717
 718             </ul>
 719         </li>
 720
 721         <li class="item" data-name="LuCI.Poll">
 722             <span class="title">
 723                 <a href="LuCI.Poll.html">LuCI.Poll</a>
 724
 725             </span>
 726             <ul class="members itemMembers">
 727
 728             </ul>
 729             <ul class="typedefs itemMembers">
 730
 731             </ul>
 732             <ul class="typedefs itemMembers">
 733
 734             </ul>
 735             <ul class="methods itemMembers">
 736
 737             <span class="subtitle">Methods</span>
 738
 739                 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
 740
 741                 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
 742
 743                 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
 744
 745                 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
 746
 747                 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
 748
 749             </ul>
 750             <ul class="events itemMembers">
 751
 752             </ul>
 753         </li>
 754
 755         <li class="item" data-name="LuCI.Request">
 756             <span class="title">
 757                 <a href="LuCI.Request.html">LuCI.Request</a>
 758
 759             </span>
 760             <ul class="members itemMembers">
 761
 762             </ul>
 763             <ul class="typedefs itemMembers">
 764
 765             <span class="subtitle">Typedefs</span>
 766
 767                 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
 768
 769                 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
 770
 771             </ul>
 772             <ul class="typedefs itemMembers">
 773
 774             </ul>
 775             <ul class="methods itemMembers">
 776
 777             <span class="subtitle">Methods</span>
 778
 779                 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
 780
 781                 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
 782
 783                 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
 784
 785                 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
 786
 787                 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
 788
 789                 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
 790
 791             </ul>
 792             <ul class="events itemMembers">
 793
 794             </ul>
 795         </li>
 796
 797         <li class="item" data-name="LuCI.Request.poll">
 798             <span class="title">
 799                 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
 800
 801             </span>
 802             <ul class="members itemMembers">
 803
 804             </ul>
 805             <ul class="typedefs itemMembers">
 806
 807             <span class="subtitle">Typedefs</span>
 808
 809                 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
 810
 811             </ul>
 812             <ul class="typedefs itemMembers">
 813
 814             </ul>
 815             <ul class="methods itemMembers">
 816
 817             <span class="subtitle">Methods</span>
 818
 819                 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
 820
 821                 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
 822
 823                 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
 824
 825                 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
 826
 827                 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
 828
 829             </ul>
 830             <ul class="events itemMembers">
 831
 832             </ul>
 833         </li>
 834
 835         <li class="item" data-name="LuCI.Response">
 836             <span class="title">
 837                 <a href="LuCI.Response.html">LuCI.Response</a>
 838
 839             </span>
 840             <ul class="members itemMembers">
 841
 842             <span class="subtitle">Members</span>
 843
 844                 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
 845
 846                 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
 847
 848                 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
 849
 850                 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
 851
 852                 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
 853
 854                 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
 855
 856             </ul>
 857             <ul class="typedefs itemMembers">
 858
 859             </ul>
 860             <ul class="typedefs itemMembers">
 861
 862             </ul>
 863             <ul class="methods itemMembers">
 864
 865             <span class="subtitle">Methods</span>
 866
 867                 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
 868
 869                 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
 870
 871                 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
 872
 873             </ul>
 874             <ul class="events itemMembers">
 875
 876             </ul>
 877         </li>
 878
 879         <li class="item" data-name="LuCI.rpc">
 880             <span class="title">
 881                 <a href="LuCI.rpc.html">LuCI.rpc</a>
 882
 883             </span>
 884             <ul class="members itemMembers">
 885
 886             </ul>
 887             <ul class="typedefs itemMembers">
 888
 889             <span class="subtitle">Typedefs</span>
 890
 891                 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
 892
 893                 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
 894
 895                 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
 896
 897                 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
 898
 899             </ul>
 900             <ul class="typedefs itemMembers">
 901
 902             </ul>
 903             <ul class="methods itemMembers">
 904
 905             <span class="subtitle">Methods</span>
 906
 907                 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
 908
 909                 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
 910
 911                 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
 912
 913                 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
 914
 915                 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
 916
 917                 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
 918
 919                 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
 920
 921                 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
 922
 923                 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
 924
 925             </ul>
 926             <ul class="events itemMembers">
 927
 928             </ul>
 929         </li>
 930
 931         <li class="item" data-name="LuCI.uci">
 932             <span class="title">
 933                 <a href="LuCI.uci.html">LuCI.uci</a>
 934
 935             </span>
 936             <ul class="members itemMembers">
 937
 938             </ul>
 939             <ul class="typedefs itemMembers">
 940
 941             <span class="subtitle">Typedefs</span>
 942
 943                 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
 944
 945                 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
 946
 947                 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
 948
 949             </ul>
 950             <ul class="typedefs itemMembers">
 951
 952             </ul>
 953             <ul class="methods itemMembers">
 954
 955             <span class="subtitle">Methods</span>
 956
 957                 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
 958
 959                 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
 960
 961                 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
 962
 963                 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
 964
 965                 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
 966
 967                 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
 968
 969                 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
 970
 971                 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
 972
 973                 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
 974
 975                 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
 976
 977                 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
 978
 979                 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
 980
 981                 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
 982
 983                 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
 984
 985                 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
 986
 987                 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
 988
 989                 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
 990
 991             </ul>
 992             <ul class="events itemMembers">
 993
 994             </ul>
 995         </li>
 996
 997         <li class="item" data-name="LuCI.view">
 998             <span class="title">
 999                 <a href="LuCI.view.html">LuCI.view</a>
1000
1001             </span>
1002             <ul class="members itemMembers">
1003
1004             </ul>
1005             <ul class="typedefs itemMembers">
1006
1007             </ul>
1008             <ul class="typedefs itemMembers">
1009
1010             </ul>
1011             <ul class="methods itemMembers">
1012
1013             <span class="subtitle">Methods</span>
1014
1015                 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1016
1017                 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1018
1019                 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1020
1021                 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1022
1023                 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1024
1025                 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1026
1027             </ul>
1028             <ul class="events itemMembers">
1029
1030             </ul>
1031         </li>
1032
1033         <li class="item" data-name="LuCI.XHR">
1034             <span class="title">
1035                 <a href="LuCI.XHR.html">LuCI.XHR</a>
1036
1037             </span>
1038             <ul class="members itemMembers">
1039
1040             </ul>
1041             <ul class="typedefs itemMembers">
1042
1043             </ul>
1044             <ul class="typedefs itemMembers">
1045
1046             </ul>
1047             <ul class="methods itemMembers">
1048
1049             <span class="subtitle">Methods</span>
1050
1051                 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1052
1053                 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1054
1055                 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1056
1057                 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1058
1059                 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1060
1061                 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1062
1063             </ul>
1064             <ul class="events itemMembers">
1065
1066             </ul>
1067         </li>
1068
1069     </ul>
1070 </div>
1071     <div class="main">
1072         <h1 class="page-title" data-filename="LuCI.Network.Protocol.html">Class: Protocol</h1>
1073
1074
1075
1076
1077 <section>
1078
1079 <header>
1080     <h2>
1081         <span class="ancestors"><a href="LuCI.html">LuCI</a><a href="LuCI.Network.html">.Network</a>.</span>
1082
1083     Protocol
1084     </h2>
1085
1086         <div class="class-description"><p>The <code>Network.Protocol</code> class serves as base for protocol specific
1087 subclasses which describe logical UCI networks defined by <code>config interface</code> sections in <code>/etc/config/network</code>.</p></div>
1088
1089 </header>
1090
1091 <article>
1092     <div class="container-overview">
1093
1094
1095
1096
1097 <dt>
1098     <div class="nameContainer">
1099         <h4 class="name" id="Protocol">
1100
1101             new LuCI.Network.Protocol<span class="signature">()</span>
1102         </h4>
1103
1104
1105         <div class="tag-source">
1106             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1850">line 1850</a>
1107         </div>
1108
1109     </div>
1110
1111
1112 </dt>
1113 <dd>
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124 <dl class="details">
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146 </dl>
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160 </dd>
1161
1162
1163     </div>
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178         <h3 class="subsection-title">Methods</h3>
1179
1180         <dl>
1181
1182 <dt>
1183     <div class="nameContainer">
1184         <h4 class="name" id="addDevice">
1185
1186             addDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1187         </h4>
1188
1189
1190         <div class="tag-source">
1191             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2439">line 2439</a>
1192         </div>
1193
1194     </div>
1195
1196
1197 </dt>
1198 <dd>
1199
1200
1201     <div class="description">
1202         <p>Add the given network device to the logical interface.</p>
1203     </div>
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213 <table class="params">
1214     <thead>
1215         <tr>
1216
1217                 <th>Name</th>
1218
1219
1220                 <th>Type</th>
1221
1222
1223
1224                 <th class="last">Description</th>
1225         </tr>
1226         </thead>
1227
1228         <tbody>
1229
1230
1231         <tr>
1232
1233                 <td class="name"><code>device</code></td>
1234
1235
1236             <td class="type">
1237
1238
1239 <span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span>
1240 |
1241
1242 <span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span>
1243 |
1244
1245 <span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span>
1246 |
1247
1248 <span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span>
1249 |
1250
1251 <span class="param-type">string</span>
1252
1253
1254
1255             </td>
1256
1257
1258
1259             <td class="description last">
1260
1261                 <p>The object or device name to add to the logical interface. In case the
1262 given argument is not a string, it is resolved though the
1263 <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td>
1264         </tr>
1265
1266
1267         </tbody>
1268 </table>
1269
1270
1271
1272 <dl class="details">
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294 </dl>
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306     <h5>Returns:</h5>
1307
1308
1309
1310 <table class="params">
1311     <thead>
1312     <tr>
1313
1314         <th>Type</th>
1315         <th class="last">Description</th>
1316     </tr>
1317     </thead>
1318     <tbody>
1319
1320         <tr>
1321
1322             <td class="type">
1323
1324                         boolean
1325
1326
1327             </td>
1328             <td class="description last">Returns <code>true</code> if the device name has been added or <code>false</code> if any
1329 argument was invalid, if the device was already part of the logical
1330 interface or if the logical interface is virtual.</td>
1331         </tr>
1332
1333     </tbody>
1334 </table>
1335
1336
1337
1338
1339 </dd>
1340
1341
1342
1343 <dt>
1344     <div class="nameContainer">
1345         <h4 class="name" id="containsDevice">
1346
1347             containsDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1348         </h4>
1349
1350
1351         <div class="tag-source">
1352             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2608">line 2608</a>
1353         </div>
1354
1355     </div>
1356
1357
1358 </dt>
1359 <dd>
1360
1361
1362     <div class="description">
1363         <p>Checks whether this logical interface contains the given device
1364 object.</p>
1365     </div>
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375 <table class="params">
1376     <thead>
1377         <tr>
1378
1379                 <th>Name</th>
1380
1381
1382                 <th>Type</th>
1383
1384
1385
1386                 <th class="last">Description</th>
1387         </tr>
1388         </thead>
1389
1390         <tbody>
1391
1392
1393         <tr>
1394
1395                 <td class="name"><code>device</code></td>
1396
1397
1398             <td class="type">
1399
1400
1401 <span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span>
1402 |
1403
1404 <span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span>
1405 |
1406
1407 <span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span>
1408 |
1409
1410 <span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span>
1411 |
1412
1413 <span class="param-type">string</span>
1414
1415
1416
1417             </td>
1418
1419
1420
1421             <td class="description last">
1422
1423                 <p>The object or device name to check. In case the given argument is not
1424 a string, it is resolved though the
1425 <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td>
1426         </tr>
1427
1428
1429         </tbody>
1430 </table>
1431
1432
1433
1434 <dl class="details">
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456 </dl>
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468     <h5>Returns:</h5>
1469
1470
1471
1472 <table class="params">
1473     <thead>
1474     <tr>
1475
1476         <th>Type</th>
1477         <th class="last">Description</th>
1478     </tr>
1479     </thead>
1480     <tbody>
1481
1482         <tr>
1483
1484             <td class="type">
1485
1486                         boolean
1487
1488
1489             </td>
1490             <td class="description last">Returns <code>true</code> when this logical interface contains the given network
1491 device or <code>false</code> if not.</td>
1492         </tr>
1493
1494     </tbody>
1495 </table>
1496
1497
1498
1499
1500 </dd>
1501
1502
1503
1504 <dt>
1505     <div class="nameContainer">
1506         <h4 class="name" id="deleteDevice">
1507
1508             deleteDevice<span class="signature">(device)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
1509         </h4>
1510
1511
1512         <div class="tag-source">
1513             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2466">line 2466</a>
1514         </div>
1515
1516     </div>
1517
1518
1519 </dt>
1520 <dd>
1521
1522
1523     <div class="description">
1524         <p>Remove the given network device from the logical interface.</p>
1525     </div>
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535 <table class="params">
1536     <thead>
1537         <tr>
1538
1539                 <th>Name</th>
1540
1541
1542                 <th>Type</th>
1543
1544
1545
1546                 <th class="last">Description</th>
1547         </tr>
1548         </thead>
1549
1550         <tbody>
1551
1552
1553         <tr>
1554
1555                 <td class="name"><code>device</code></td>
1556
1557
1558             <td class="type">
1559
1560
1561 <span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span>
1562 |
1563
1564 <span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span>
1565 |
1566
1567 <span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span>
1568 |
1569
1570 <span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span>
1571 |
1572
1573 <span class="param-type">string</span>
1574
1575
1576
1577             </td>
1578
1579
1580
1581             <td class="description last">
1582
1583                 <p>The object or device name to remove from the logical interface. In case
1584 the given argument is not a string, it is resolved though the
1585 <a href="LuCI.Network.html#getIfnameOf"><code>Network.getIfnameOf()</code></a> function.</p></td>
1586         </tr>
1587
1588
1589         </tbody>
1590 </table>
1591
1592
1593
1594 <dl class="details">
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616 </dl>
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628     <h5>Returns:</h5>
1629
1630
1631
1632 <table class="params">
1633     <thead>
1634     <tr>
1635
1636         <th>Type</th>
1637         <th class="last">Description</th>
1638     </tr>
1639     </thead>
1640     <tbody>
1641
1642         <tr>
1643
1644             <td class="type">
1645
1646                         boolean
1647
1648
1649             </td>
1650             <td class="description last">Returns <code>true</code> if the device name has been added or <code>false</code> if any
1651 argument was invalid, if the device was already part of the logical
1652 interface or if the logical interface is virtual.</td>
1653         </tr>
1654
1655     </tbody>
1656 </table>
1657
1658
1659
1660
1661 </dd>
1662
1663
1664
1665 <dt>
1666     <div class="nameContainer">
1667         <h4 class="name" id="get">
1668
1669             get<span class="signature">(opt)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string|Array.&lt;string>}</span>
1670         </h4>
1671
1672
1673         <div class="tag-source">
1674             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1883">line 1883</a>
1675         </div>
1676
1677     </div>
1678
1679
1680 </dt>
1681 <dd>
1682
1683
1684     <div class="description">
1685         <p>Read the given UCI option value of this network.</p>
1686     </div>
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696 <table class="params">
1697     <thead>
1698         <tr>
1699
1700                 <th>Name</th>
1701
1702
1703                 <th>Type</th>
1704
1705
1706
1707                 <th class="last">Description</th>
1708         </tr>
1709         </thead>
1710
1711         <tbody>
1712
1713
1714         <tr>
1715
1716                 <td class="name"><code>opt</code></td>
1717
1718
1719             <td class="type">
1720
1721
1722 <span class="param-type">string</span>
1723
1724
1725
1726             </td>
1727
1728
1729
1730             <td class="description last">
1731
1732                 <p>The UCI option name to read.</p></td>
1733         </tr>
1734
1735
1736         </tbody>
1737 </table>
1738
1739
1740
1741 <dl class="details">
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763 </dl>
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775     <h5>Returns:</h5>
1776
1777
1778
1779 <table class="params">
1780     <thead>
1781     <tr>
1782
1783         <th>Type</th>
1784         <th class="last">Description</th>
1785     </tr>
1786     </thead>
1787     <tbody>
1788
1789         <tr>
1790
1791             <td class="type">
1792
1793                         null
1794                          |
1795
1796                         string
1797                          |
1798
1799                         Array.&lt;string>
1800
1801
1802             </td>
1803             <td class="description last">Returns the UCI option value or <code>null</code> if the requested option is
1804 not found.</td>
1805         </tr>
1806
1807     </tbody>
1808 </table>
1809
1810
1811
1812
1813 </dd>
1814
1815
1816
1817 <dt>
1818     <div class="nameContainer">
1819         <h4 class="name" id="getDevice">
1820
1821             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>
1822         </h4>
1823
1824
1825         <div class="tag-source">
1826             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2493">line 2493</a>
1827         </div>
1828
1829     </div>
1830
1831
1832 </dt>
1833 <dd>
1834
1835
1836     <div class="description">
1837         <p>Returns the Linux network device associated with this logical
1838 interface.</p>
1839     </div>
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849 <dl class="details">
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871 </dl>
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883     <h5>Returns:</h5>
1884
1885
1886
1887 <table class="params">
1888     <thead>
1889     <tr>
1890
1891         <th>Type</th>
1892         <th class="last">Description</th>
1893     </tr>
1894     </thead>
1895     <tbody>
1896
1897         <tr>
1898
1899             <td class="type">
1900
1901                         <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
1902
1903
1904             </td>
1905             <td class="description last">Returns a <code>Network.Device</code> class instance representing the
1906 expected Linux network device according to the configuration.</td>
1907         </tr>
1908
1909     </tbody>
1910 </table>
1911
1912
1913
1914
1915 </dd>
1916
1917
1918
1919 <dt>
1920     <div class="nameContainer">
1921         <h4 class="name" id="getDevices">
1922
1923             getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|Array.&lt;<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>}</span>
1924         </h4>
1925
1926
1927         <div class="tag-source">
1928             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2554">line 2554</a>
1929         </div>
1930
1931     </div>
1932
1933
1934 </dt>
1935 <dd>
1936
1937
1938     <div class="description">
1939         <p>Returns a list of network sub-devices associated with this logical
1940 interface.</p>
1941     </div>
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951 <dl class="details">
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973 </dl>
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985     <h5>Returns:</h5>
1986
1987
1988
1989 <table class="params">
1990     <thead>
1991     <tr>
1992
1993         <th>Type</th>
1994         <th class="last">Description</th>
1995     </tr>
1996     </thead>
1997     <tbody>
1998
1999         <tr>
2000
2001             <td class="type">
2002
2003                         null
2004                          |
2005
2006                         Array.&lt;<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>
2007
2008
2009             </td>
2010             <td class="description last">Returns an array of of <code>Network.Device</code> class instances representing
2011 the sub-devices attached to this logical interface or <code>null</code> if the
2012 logical interface does not support sub-devices, e.g. because it is
2013 virtual and not a bridge.</td>
2014         </tr>
2015
2016     </tbody>
2017 </table>
2018
2019
2020
2021
2022 </dd>
2023
2024
2025
2026 <dt>
2027     <div class="nameContainer">
2028         <h4 class="name" id="getDNS6Addrs">
2029
2030             getDNS6Addrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
2031         </h4>
2032
2033
2034         <div class="tag-source">
2035             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2208">line 2208</a>
2036         </div>
2037
2038     </div>
2039
2040
2041 </dt>
2042 <dd>
2043
2044
2045     <div class="description">
2046         <p>Query the IPv6 DNS servers associated with the logical interface.</p>
2047     </div>
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057 <dl class="details">
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079 </dl>
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091     <h5>Returns:</h5>
2092
2093
2094
2095 <table class="params">
2096     <thead>
2097     <tr>
2098
2099         <th>Type</th>
2100         <th class="last">Description</th>
2101     </tr>
2102     </thead>
2103     <tbody>
2104
2105         <tr>
2106
2107             <td class="type">
2108
2109                         Array.&lt;string>
2110
2111
2112             </td>
2113             <td class="description last">Returns an array of IPv6 DNS servers registered by the remote
2114 protocol backend.</td>
2115         </tr>
2116
2117     </tbody>
2118 </table>
2119
2120
2121
2122
2123 </dd>
2124
2125
2126
2127 <dt>
2128     <div class="nameContainer">
2129         <h4 class="name" id="getDNSAddrs">
2130
2131             getDNSAddrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
2132         </h4>
2133
2134
2135         <div class="tag-source">
2136             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2120">line 2120</a>
2137         </div>
2138
2139     </div>
2140
2141
2142 </dt>
2143 <dd>
2144
2145
2146     <div class="description">
2147         <p>Query the IPv4 DNS servers associated with the logical interface.</p>
2148     </div>
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158 <dl class="details">
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180 </dl>
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192     <h5>Returns:</h5>
2193
2194
2195
2196 <table class="params">
2197     <thead>
2198     <tr>
2199
2200         <th>Type</th>
2201         <th class="last">Description</th>
2202     </tr>
2203     </thead>
2204     <tbody>
2205
2206         <tr>
2207
2208             <td class="type">
2209
2210                         Array.&lt;string>
2211
2212
2213             </td>
2214             <td class="description last">Returns an array of IPv4 DNS servers registered by the remote
2215 protocol backend.</td>
2216         </tr>
2217
2218     </tbody>
2219 </table>
2220
2221
2222
2223
2224 </dd>
2225
2226
2227
2228 <dt>
2229     <div class="nameContainer">
2230         <h4 class="name" id="getErrors">
2231
2232             getErrors<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
2233         </h4>
2234
2235
2236         <div class="tag-source">
2237             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2252">line 2252</a>
2238         </div>
2239
2240     </div>
2241
2242
2243 </dt>
2244 <dd>
2245
2246
2247     <div class="description">
2248         <p>Query interface error messages published in <code>ubus</code> runtime state.</p>
2249 <p>Interface errors are emitted by remote protocol handlers if the setup
2250 of the underlying logical interface failed, e.g. due to bad
2251 configuration or network connectivity issues.</p>
2252 <p>This function will translate the found error codes to human readable
2253 messages using the descriptions registered by
2254 <a href="LuCI.Network.html#registerErrorCode"><code>Network.registerErrorCode()</code></a>
2255 and fall back to <code>&quot;Unknown error (%s)&quot;</code> where <code>%s</code> is replaced by the
2256 error code in case no translation can be found.</p>
2257     </div>
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267 <dl class="details">
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289 </dl>
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301     <h5>Returns:</h5>
2302
2303
2304
2305 <table class="params">
2306     <thead>
2307     <tr>
2308
2309         <th>Type</th>
2310         <th class="last">Description</th>
2311     </tr>
2312     </thead>
2313     <tbody>
2314
2315         <tr>
2316
2317             <td class="type">
2318
2319                         Array.&lt;string>
2320
2321
2322             </td>
2323             <td class="description last">Returns an array of translated interface error messages.</td>
2324         </tr>
2325
2326     </tbody>
2327 </table>
2328
2329
2330
2331
2332 </dd>
2333
2334
2335
2336 <dt>
2337     <div class="nameContainer">
2338         <h4 class="name" id="getExpiry">
2339
2340             getExpiry<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
2341         </h4>
2342
2343
2344         <div class="tag-source">
2345             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2003">line 2003</a>
2346         </div>
2347
2348     </div>
2349
2350
2351 </dt>
2352 <dd>
2353
2354
2355     <div class="description">
2356         <p>Get the logical interface expiry time in seconds.</p>
2357 <p>For protocols that have a concept of a lease, such as DHCP or
2358 DHCPv6, this function returns the remaining time in seconds
2359 until the lease expires.</p>
2360     </div>
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370 <dl class="details">
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392 </dl>
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404     <h5>Returns:</h5>
2405
2406
2407
2408 <table class="params">
2409     <thead>
2410     <tr>
2411
2412         <th>Type</th>
2413         <th class="last">Description</th>
2414     </tr>
2415     </thead>
2416     <tbody>
2417
2418         <tr>
2419
2420             <td class="type">
2421
2422                         number
2423
2424
2425             </td>
2426             <td class="description last">Returns the amount of seconds until the lease expires or <code>-1</code>
2427 if it isn't applicable to the associated protocol.</td>
2428         </tr>
2429
2430     </tbody>
2431 </table>
2432
2433
2434
2435
2436 </dd>
2437
2438
2439
2440 <dt>
2441     <div class="nameContainer">
2442         <h4 class="name" id="getGateway6Addr">
2443
2444             getGateway6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2445         </h4>
2446
2447
2448         <div class="tag-source">
2449             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2188">line 2188</a>
2450         </div>
2451
2452     </div>
2453
2454
2455 </dt>
2456 <dd>
2457
2458
2459     <div class="description">
2460         <p>Query the gateway (nexthop) of the IPv6 default route associated with
2461 this logical interface.</p>
2462     </div>
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472 <dl class="details">
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494 </dl>
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506     <h5>Returns:</h5>
2507
2508
2509
2510 <table class="params">
2511     <thead>
2512     <tr>
2513
2514         <th>Type</th>
2515         <th class="last">Description</th>
2516     </tr>
2517     </thead>
2518     <tbody>
2519
2520         <tr>
2521
2522             <td class="type">
2523
2524                         string
2525
2526
2527             </td>
2528             <td class="description last">Returns a string containing the IPv6 nexthop address of the associated
2529 default route or <code>null</code> if no default route was found.</td>
2530         </tr>
2531
2532     </tbody>
2533 </table>
2534
2535
2536
2537
2538 </dd>
2539
2540
2541
2542 <dt>
2543     <div class="nameContainer">
2544         <h4 class="name" id="getGatewayAddr">
2545
2546             getGatewayAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
2547         </h4>
2548
2549
2550         <div class="tag-source">
2551             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2100">line 2100</a>
2552         </div>
2553
2554     </div>
2555
2556
2557 </dt>
2558 <dd>
2559
2560
2561     <div class="description">
2562         <p>Query the gateway (nexthop) of the default route associated with
2563 this logical interface.</p>
2564     </div>
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574 <dl class="details">
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596 </dl>
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608     <h5>Returns:</h5>
2609
2610
2611
2612 <table class="params">
2613     <thead>
2614     <tr>
2615
2616         <th>Type</th>
2617         <th class="last">Description</th>
2618     </tr>
2619     </thead>
2620     <tbody>
2621
2622         <tr>
2623
2624             <td class="type">
2625
2626                         string
2627
2628
2629             </td>
2630             <td class="description last">Returns a string containing the IPv4 nexthop address of the associated
2631 default route or <code>null</code> if no default route was found.</td>
2632         </tr>
2633
2634     </tbody>
2635 </table>
2636
2637
2638
2639
2640 </dd>
2641
2642
2643
2644 <dt>
2645     <div class="nameContainer">
2646         <h4 class="name" id="getI18n">
2647
2648             <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>
2649         </h4>
2650
2651
2652         <div class="tag-source">
2653             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1948">line 1948</a>
2654         </div>
2655
2656     </div>
2657
2658
2659 </dt>
2660 <dd>
2661
2662
2663     <div class="description">
2664         <p>Return a human readable description for the protcol, such as
2665 <code>Static address</code> or <code>DHCP client</code>.</p>
2666 <p>This function should be overwritten by subclasses.</p>
2667     </div>
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677 <dl class="details">
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699 </dl>
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711     <h5>Returns:</h5>
2712
2713
2714
2715 <table class="params">
2716     <thead>
2717     <tr>
2718
2719         <th>Type</th>
2720         <th class="last">Description</th>
2721     </tr>
2722     </thead>
2723     <tbody>
2724
2725         <tr>
2726
2727             <td class="type">
2728
2729                         string
2730
2731
2732             </td>
2733             <td class="description last">Returns the description string.</td>
2734         </tr>
2735
2736     </tbody>
2737 </table>
2738
2739
2740
2741
2742 </dd>
2743
2744
2745
2746 <dt>
2747     <div class="nameContainer">
2748         <h4 class="name" id="getIfname">
2749
2750             getIfname<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2751         </h4>
2752
2753
2754         <div class="tag-source">
2755             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1908">line 1908</a>
2756         </div>
2757
2758     </div>
2759
2760
2761 </dt>
2762 <dd>
2763
2764
2765     <div class="description">
2766         <p>Get the associared Linux network device of this network.</p>
2767     </div>
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777 <dl class="details">
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799 </dl>
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811     <h5>Returns:</h5>
2812
2813
2814
2815 <table class="params">
2816     <thead>
2817     <tr>
2818
2819         <th>Type</th>
2820         <th class="last">Description</th>
2821     </tr>
2822     </thead>
2823     <tbody>
2824
2825         <tr>
2826
2827             <td class="type">
2828
2829                         null
2830                          |
2831
2832                         string
2833
2834
2835             </td>
2836             <td class="description last">Returns the name of the associated network device or <code>null</code> if
2837 it could not be determined.</td>
2838         </tr>
2839
2840     </tbody>
2841 </table>
2842
2843
2844
2845
2846 </dd>
2847
2848
2849
2850 <dt>
2851     <div class="nameContainer">
2852         <h4 class="name" id="getIP6Addr">
2853
2854             getIP6Addr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
2855         </h4>
2856
2857
2858         <div class="tag-source">
2859             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2139">line 2139</a>
2860         </div>
2861
2862     </div>
2863
2864
2865 </dt>
2866 <dd>
2867
2868
2869     <div class="description">
2870         <p>Query the first (primary) IPv6 address of the logical interface.</p>
2871     </div>
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881 <dl class="details">
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903 </dl>
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915     <h5>Returns:</h5>
2916
2917
2918
2919 <table class="params">
2920     <thead>
2921     <tr>
2922
2923         <th>Type</th>
2924         <th class="last">Description</th>
2925     </tr>
2926     </thead>
2927     <tbody>
2928
2929         <tr>
2930
2931             <td class="type">
2932
2933                         null
2934                          |
2935
2936                         string
2937
2938
2939             </td>
2940             <td class="description last">Returns the primary IPv6 address registered by the protocol handler
2941 in CIDR notation or <code>null</code> if no IPv6 addresses were set.</td>
2942         </tr>
2943
2944     </tbody>
2945 </table>
2946
2947
2948
2949
2950 </dd>
2951
2952
2953
2954 <dt>
2955     <div class="nameContainer">
2956         <h4 class="name" id="getIP6Addrs">
2957
2958             getIP6Addrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
2959         </h4>
2960
2961
2962         <div class="tag-source">
2963             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2161">line 2161</a>
2964         </div>
2965
2966     </div>
2967
2968
2969 </dt>
2970 <dd>
2971
2972
2973     <div class="description">
2974         <p>Query all IPv6 addresses of the logical interface.</p>
2975     </div>
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985 <dl class="details">
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007 </dl>
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019     <h5>Returns:</h5>
3020
3021
3022
3023 <table class="params">
3024     <thead>
3025     <tr>
3026
3027         <th>Type</th>
3028         <th class="last">Description</th>
3029     </tr>
3030     </thead>
3031     <tbody>
3032
3033         <tr>
3034
3035             <td class="type">
3036
3037                         Array.&lt;string>
3038
3039
3040             </td>
3041             <td class="description last">Returns an array of IPv6 addresses in CIDR notation which have been
3042 registered by the protocol handler. The order of the resulting array
3043 follows the order of the addresses in <code>ubus</code> runtime information.</td>
3044         </tr>
3045
3046     </tbody>
3047 </table>
3048
3049
3050
3051
3052 </dd>
3053
3054
3055
3056 <dt>
3057     <div class="nameContainer">
3058         <h4 class="name" id="getIP6Prefix">
3059
3060             getIP6Prefix<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3061         </h4>
3062
3063
3064         <div class="tag-source">
3065             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2227">line 2227</a>
3066         </div>
3067
3068     </div>
3069
3070
3071 </dt>
3072 <dd>
3073
3074
3075     <div class="description">
3076         <p>Query the routed IPv6 prefix associated with the logical interface.</p>
3077     </div>
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087 <dl class="details">
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109 </dl>
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121     <h5>Returns:</h5>
3122
3123
3124
3125 <table class="params">
3126     <thead>
3127     <tr>
3128
3129         <th>Type</th>
3130         <th class="last">Description</th>
3131     </tr>
3132     </thead>
3133     <tbody>
3134
3135         <tr>
3136
3137             <td class="type">
3138
3139                         null
3140                          |
3141
3142                         string
3143
3144
3145             </td>
3146             <td class="description last">Returns the routed IPv6 prefix registered by the remote protocol
3147 handler or <code>null</code> if no prefix is present.</td>
3148         </tr>
3149
3150     </tbody>
3151 </table>
3152
3153
3154
3155
3156 </dd>
3157
3158
3159
3160 <dt>
3161     <div class="nameContainer">
3162         <h4 class="name" id="getIPAddr">
3163
3164             getIPAddr<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3165         </h4>
3166
3167
3168         <div class="tag-source">
3169             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2055">line 2055</a>
3170         </div>
3171
3172     </div>
3173
3174
3175 </dt>
3176 <dd>
3177
3178
3179     <div class="description">
3180         <p>Query the first (primary) IPv4 address of the logical interface.</p>
3181     </div>
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191 <dl class="details">
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213 </dl>
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225     <h5>Returns:</h5>
3226
3227
3228
3229 <table class="params">
3230     <thead>
3231     <tr>
3232
3233         <th>Type</th>
3234         <th class="last">Description</th>
3235     </tr>
3236     </thead>
3237     <tbody>
3238
3239         <tr>
3240
3241             <td class="type">
3242
3243                         null
3244                          |
3245
3246                         string
3247
3248
3249             </td>
3250             <td class="description last">Returns the primary IPv4 address registered by the protocol handler
3251 or <code>null</code> if no IPv4 addresses were set.</td>
3252         </tr>
3253
3254     </tbody>
3255 </table>
3256
3257
3258
3259
3260 </dd>
3261
3262
3263
3264 <dt>
3265     <div class="nameContainer">
3266         <h4 class="name" id="getIPAddrs">
3267
3268             getIPAddrs<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.&lt;string>}</span>
3269         </h4>
3270
3271
3272         <div class="tag-source">
3273             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2068">line 2068</a>
3274         </div>
3275
3276     </div>
3277
3278
3279 </dt>
3280 <dd>
3281
3282
3283     <div class="description">
3284         <p>Query all IPv4 addresses of the logical interface.</p>
3285     </div>
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295 <dl class="details">
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317 </dl>
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329     <h5>Returns:</h5>
3330
3331
3332
3333 <table class="params">
3334     <thead>
3335     <tr>
3336
3337         <th>Type</th>
3338         <th class="last">Description</th>
3339     </tr>
3340     </thead>
3341     <tbody>
3342
3343         <tr>
3344
3345             <td class="type">
3346
3347                         Array.&lt;string>
3348
3349
3350             </td>
3351             <td class="description last">Returns an array of IPv4 addresses in CIDR notation which have been
3352 registered by the protocol handler. The order of the resulting array
3353 follows the order of the addresses in <code>ubus</code> runtime information.</td>
3354         </tr>
3355
3356     </tbody>
3357 </table>
3358
3359
3360
3361
3362 </dd>
3363
3364
3365
3366 <dt>
3367     <div class="nameContainer">
3368         <h4 class="name" id="getL2Device">
3369
3370             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>
3371         </h4>
3372
3373
3374         <div class="tag-source">
3375             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2526">line 2526</a>
3376         </div>
3377
3378     </div>
3379
3380
3381 </dt>
3382 <dd>
3383
3384
3385     <div class="description">
3386         <p>Returns the layer 2 linux network device currently associated
3387 with this logical interface.</p>
3388     </div>
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398 <dl class="details">
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420 </dl>
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432     <h5>Returns:</h5>
3433
3434
3435
3436 <table class="params">
3437     <thead>
3438     <tr>
3439
3440         <th>Type</th>
3441         <th class="last">Description</th>
3442     </tr>
3443     </thead>
3444     <tbody>
3445
3446         <tr>
3447
3448             <td class="type">
3449
3450                         <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
3451
3452
3453             </td>
3454             <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux
3455 network device currently associated with the logical interface.</td>
3456         </tr>
3457
3458     </tbody>
3459 </table>
3460
3461
3462
3463
3464 </dd>
3465
3466
3467
3468 <dt>
3469     <div class="nameContainer">
3470         <h4 class="name" id="getL3Device">
3471
3472             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>
3473         </h4>
3474
3475
3476         <div class="tag-source">
3477             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2539">line 2539</a>
3478         </div>
3479
3480     </div>
3481
3482
3483 </dt>
3484 <dd>
3485
3486
3487     <div class="description">
3488         <p>Returns the layer 3 linux network device currently associated
3489 with this logical interface.</p>
3490     </div>
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500 <dl class="details">
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522 </dl>
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534     <h5>Returns:</h5>
3535
3536
3537
3538 <table class="params">
3539     <thead>
3540     <tr>
3541
3542         <th>Type</th>
3543         <th class="last">Description</th>
3544     </tr>
3545     </thead>
3546     <tbody>
3547
3548         <tr>
3549
3550             <td class="type">
3551
3552                         <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
3553
3554
3555             </td>
3556             <td class="description last">Returns a <code>Network.Device</code> class instance representing the Linux
3557 network device currently associated with the logical interface.</td>
3558         </tr>
3559
3560     </tbody>
3561 </table>
3562
3563
3564
3565
3566 </dd>
3567
3568
3569
3570 <dt>
3571     <div class="nameContainer">
3572         <h4 class="name" id="getMetric">
3573
3574             getMetric<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
3575         </h4>
3576
3577
3578         <div class="tag-source">
3579             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2023">line 2023</a>
3580         </div>
3581
3582     </div>
3583
3584
3585 </dt>
3586 <dd>
3587
3588
3589     <div class="description">
3590         <p>Get the metric value of the logical interface.</p>
3591     </div>
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601 <dl class="details">
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623 </dl>
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635     <h5>Returns:</h5>
3636
3637
3638
3639 <table class="params">
3640     <thead>
3641     <tr>
3642
3643         <th>Type</th>
3644         <th class="last">Description</th>
3645     </tr>
3646     </thead>
3647     <tbody>
3648
3649         <tr>
3650
3651             <td class="type">
3652
3653                         number
3654
3655
3656             </td>
3657             <td class="description last">Returns the current metric value used for device and network
3658 routes spawned by the associated logical interface.</td>
3659         </tr>
3660
3661     </tbody>
3662 </table>
3663
3664
3665
3666
3667 </dd>
3668
3669
3670
3671 <dt>
3672     <div class="nameContainer">
3673         <h4 class="name" id="getName">
3674
3675             getName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{string}</span>
3676         </h4>
3677
3678
3679         <div class="tag-source">
3680             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1978">line 1978</a>
3681         </div>
3682
3683     </div>
3684
3685
3686 </dt>
3687 <dd>
3688
3689
3690     <div class="description">
3691         <p>Get the name of the associated logical interface.</p>
3692     </div>
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702 <dl class="details">
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724 </dl>
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736     <h5>Returns:</h5>
3737
3738
3739
3740 <table class="params">
3741     <thead>
3742     <tr>
3743
3744         <th>Type</th>
3745         <th class="last">Description</th>
3746     </tr>
3747     </thead>
3748     <tbody>
3749
3750         <tr>
3751
3752             <td class="type">
3753
3754                         string
3755
3756
3757             </td>
3758             <td class="description last">Returns the logical interface name, such as <code>lan</code> or <code>wan</code>.</td>
3759         </tr>
3760
3761     </tbody>
3762 </table>
3763
3764
3765
3766
3767 </dd>
3768
3769
3770
3771 <dt>
3772     <div class="nameContainer">
3773         <h4 class="name" id="getNetmask">
3774
3775             getNetmask<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
3776         </h4>
3777
3778
3779         <div class="tag-source">
3780             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2086">line 2086</a>
3781         </div>
3782
3783     </div>
3784
3785
3786 </dt>
3787 <dd>
3788
3789
3790     <div class="description">
3791         <p>Query the first (primary) IPv4 netmask of the logical interface.</p>
3792     </div>
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802 <dl class="details">
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824 </dl>
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836     <h5>Returns:</h5>
3837
3838
3839
3840 <table class="params">
3841     <thead>
3842     <tr>
3843
3844         <th>Type</th>
3845         <th class="last">Description</th>
3846     </tr>
3847     </thead>
3848     <tbody>
3849
3850         <tr>
3851
3852             <td class="type">
3853
3854                         null
3855                          |
3856
3857                         string
3858
3859
3860             </td>
3861             <td class="description last">Returns the netmask of the primary IPv4 address registered by the
3862 protocol handler or <code>null</code> if no IPv4 addresses were set.</td>
3863         </tr>
3864
3865     </tbody>
3866 </table>
3867
3868
3869
3870
3871 </dd>
3872
3873
3874
3875 <dt>
3876     <div class="nameContainer">
3877         <h4 class="name" id="getOpkgPackage">
3878
3879             <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>
3880         </h4>
3881
3882
3883         <div class="tag-source">
3884             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2292">line 2292</a>
3885         </div>
3886
3887     </div>
3888
3889
3890 </dt>
3891 <dd>
3892
3893
3894     <div class="description">
3895         <p>Get the name of the opkg package providing the protocol functionality.</p>
3896 <p>This function should be overwritten by protocol specific subclasses.</p>
3897     </div>
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907 <dl class="details">
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929 </dl>
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941     <h5>Returns:</h5>
3942
3943
3944
3945 <table class="params">
3946     <thead>
3947     <tr>
3948
3949         <th>Type</th>
3950         <th class="last">Description</th>
3951     </tr>
3952     </thead>
3953     <tbody>
3954
3955         <tr>
3956
3957             <td class="type">
3958
3959                         string
3960
3961
3962             </td>
3963             <td class="description last">Returns the name of the opkg package required for the protocol to
3964 function, e.g. <code>odhcp6c</code> for the <code>dhcpv6</code> prototocol.</td>
3965         </tr>
3966
3967     </tbody>
3968 </table>
3969
3970
3971
3972
3973 </dd>
3974
3975
3976
3977 <dt>
3978     <div class="nameContainer">
3979         <h4 class="name" id="getProtocol">
3980
3981             <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>
3982         </h4>
3983
3984
3985         <div class="tag-source">
3986             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1934">line 1934</a>
3987         </div>
3988
3989     </div>
3990
3991
3992 </dt>
3993 <dd>
3994
3995
3996     <div class="description">
3997         <p>Get the name of this network protocol class.</p>
3998 <p>This function will be overwritten by subclasses created by
3999 <a href="LuCI.Network.html#registerProtocol"><code>Network.registerProtocol()</code></a>.</p>
4000     </div>
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010 <dl class="details">
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032 </dl>
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044     <h5>Returns:</h5>
4045
4046
4047
4048 <table class="params">
4049     <thead>
4050     <tr>
4051
4052         <th>Type</th>
4053         <th class="last">Description</th>
4054     </tr>
4055     </thead>
4056     <tbody>
4057
4058         <tr>
4059
4060             <td class="type">
4061
4062                         string
4063
4064
4065             </td>
4066             <td class="description last">Returns the name of the network protocol implementation, e.g.
4067 <code>static</code> or <code>dhcp</code>.</td>
4068         </tr>
4069
4070     </tbody>
4071 </table>
4072
4073
4074
4075
4076 </dd>
4077
4078
4079
4080 <dt>
4081     <div class="nameContainer">
4082         <h4 class="name" id="getType">
4083
4084             getType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4085         </h4>
4086
4087
4088         <div class="tag-source">
4089             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1968">line 1968</a>
4090         </div>
4091
4092     </div>
4093
4094
4095 </dt>
4096 <dd>
4097
4098
4099     <div class="description">
4100         <p>Get the type of the underlying interface.</p>
4101 <p>This function actually is a convenience wrapper around
4102 <code>proto.get(&quot;type&quot;)</code> and is mainly used by other <code>LuCI.Network</code> code
4103 to check whether the interface is declared as bridge in UCI.</p>
4104     </div>
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114 <dl class="details">
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136 </dl>
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148     <h5>Returns:</h5>
4149
4150
4151
4152 <table class="params">
4153     <thead>
4154     <tr>
4155
4156         <th>Type</th>
4157         <th class="last">Description</th>
4158     </tr>
4159     </thead>
4160     <tbody>
4161
4162         <tr>
4163
4164             <td class="type">
4165
4166                         null
4167                          |
4168
4169                         string
4170
4171
4172             </td>
4173             <td class="description last">Returns the value of the <code>type</code> option of the associated logical
4174 interface or <code>null</code> if no <code>type</code> option is set.</td>
4175         </tr>
4176
4177     </tbody>
4178 </table>
4179
4180
4181
4182
4183 </dd>
4184
4185
4186
4187 <dt>
4188     <div class="nameContainer">
4189         <h4 class="name" id="getUptime">
4190
4191             getUptime<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{number}</span>
4192         </h4>
4193
4194
4195         <div class="tag-source">
4196             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1988">line 1988</a>
4197         </div>
4198
4199     </div>
4200
4201
4202 </dt>
4203 <dd>
4204
4205
4206     <div class="description">
4207         <p>Get the uptime of the logical interface.</p>
4208     </div>
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218 <dl class="details">
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240 </dl>
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252     <h5>Returns:</h5>
4253
4254
4255
4256 <table class="params">
4257     <thead>
4258     <tr>
4259
4260         <th>Type</th>
4261         <th class="last">Description</th>
4262     </tr>
4263     </thead>
4264     <tbody>
4265
4266         <tr>
4267
4268             <td class="type">
4269
4270                         number
4271
4272
4273             </td>
4274             <td class="description last">Returns the uptime of the associated interface in seconds.</td>
4275         </tr>
4276
4277     </tbody>
4278 </table>
4279
4280
4281
4282
4283 </dd>
4284
4285
4286
4287 <dt>
4288     <div class="nameContainer">
4289         <h4 class="name" id="getZoneName">
4290
4291             getZoneName<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4292         </h4>
4293
4294
4295         <div class="tag-source">
4296             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2039">line 2039</a>
4297         </div>
4298
4299     </div>
4300
4301
4302 </dt>
4303 <dd>
4304
4305
4306     <div class="description">
4307         <p>Get the requested firewall zone name of the logical interface.</p>
4308 <p>Some protocol implementations request a specific firewall zone
4309 to trigger inclusion of their resulting network devices into the
4310 firewall rule set.</p>
4311     </div>
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321 <dl class="details">
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343 </dl>
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355     <h5>Returns:</h5>
4356
4357
4358
4359 <table class="params">
4360     <thead>
4361     <tr>
4362
4363         <th>Type</th>
4364         <th class="last">Description</th>
4365     </tr>
4366     </thead>
4367     <tbody>
4368
4369         <tr>
4370
4371             <td class="type">
4372
4373                         null
4374                          |
4375
4376                         string
4377
4378
4379             </td>
4380             <td class="description last">Returns the requested firewall zone name as published in the
4381 <code>ubus</code> runtime information or <code>null</code> if the remote protocol
4382 handler didn't request a zone.</td>
4383         </tr>
4384
4385     </tbody>
4386 </table>
4387
4388
4389
4390
4391 </dd>
4392
4393
4394
4395 <dt>
4396     <div class="nameContainer">
4397         <h4 class="name" id="isAlias">
4398
4399             isAlias<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span>
4400         </h4>
4401
4402
4403         <div class="tag-source">
4404             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2380">line 2380</a>
4405         </div>
4406
4407     </div>
4408
4409
4410 </dt>
4411 <dd>
4412
4413
4414     <div class="description">
4415         <p>Checks whether this interface is an alias interface.</p>
4416 <p>Alias interfaces are interfaces layering on top of another interface
4417 and are denoted by a special <code>@interfacename</code> notation in the
4418 underlying <code>ifname</code> option.</p>
4419     </div>
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429 <dl class="details">
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451 </dl>
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463     <h5>Returns:</h5>
4464
4465
4466
4467 <table class="params">
4468     <thead>
4469     <tr>
4470
4471         <th>Type</th>
4472         <th class="last">Description</th>
4473     </tr>
4474     </thead>
4475     <tbody>
4476
4477         <tr>
4478
4479             <td class="type">
4480
4481                         null
4482                          |
4483
4484                         string
4485
4486
4487             </td>
4488             <td class="description last">Returns the name of the parent interface if this logical interface
4489 is an alias or <code>null</code> if it is not an alias interface.</td>
4490         </tr>
4491
4492     </tbody>
4493 </table>
4494
4495
4496
4497
4498 </dd>
4499
4500
4501
4502 <dt>
4503     <div class="nameContainer">
4504         <h4 class="name" id="isBridge">
4505
4506             isBridge<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4507         </h4>
4508
4509
4510         <div class="tag-source">
4511             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2277">line 2277</a>
4512         </div>
4513
4514     </div>
4515
4516
4517 </dt>
4518 <dd>
4519
4520
4521     <div class="description">
4522         <p>Checks whether the underlying logical interface is declared as bridge.</p>
4523     </div>
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533 <dl class="details">
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555 </dl>
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567     <h5>Returns:</h5>
4568
4569
4570
4571 <table class="params">
4572     <thead>
4573     <tr>
4574
4575         <th>Type</th>
4576         <th class="last">Description</th>
4577     </tr>
4578     </thead>
4579     <tbody>
4580
4581         <tr>
4582
4583             <td class="type">
4584
4585                         boolean
4586
4587
4588             </td>
4589             <td class="description last">Returns <code>true</code> when the interface is declared with <code>option type bridge</code>
4590 and when the associated protocol implementation is not marked virtual
4591 or <code>false</code> when the logical interface is no bridge.</td>
4592         </tr>
4593
4594     </tbody>
4595 </table>
4596
4597
4598
4599
4600 </dd>
4601
4602
4603
4604 <dt>
4605     <div class="nameContainer">
4606         <h4 class="name" id="isDynamic">
4607
4608             isDynamic<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4609         </h4>
4610
4611
4612         <div class="tag-source">
4613             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2365">line 2365</a>
4614         </div>
4615
4616     </div>
4617
4618
4619 </dt>
4620 <dd>
4621
4622
4623     <div class="description">
4624         <p>Checks whether this logical interface is dynamic.</p>
4625 <p>A dynamic interface is an interface which has been created at runtime,
4626 e.g. as sub-interface of another interface, but which is not backed by
4627 any user configuration. Such dynamic interfaces cannot be edited but
4628 only brought down or restarted.</p>
4629     </div>
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639 <dl class="details">
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661 </dl>
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673     <h5>Returns:</h5>
4674
4675
4676
4677 <table class="params">
4678     <thead>
4679     <tr>
4680
4681         <th>Type</th>
4682         <th class="last">Description</th>
4683     </tr>
4684     </thead>
4685     <tbody>
4686
4687         <tr>
4688
4689             <td class="type">
4690
4691                         boolean
4692
4693
4694             </td>
4695             <td class="description last">Returns a boolean indicating whether this interface is dynamic (<code>true</code>)
4696 or not (<code>false</code>).</td>
4697         </tr>
4698
4699     </tbody>
4700 </table>
4701
4702
4703
4704
4705 </dd>
4706
4707
4708
4709 <dt>
4710     <div class="nameContainer">
4711         <h4 class="name" id="isEmpty">
4712
4713             isEmpty<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4714         </h4>
4715
4716
4717         <div class="tag-source">
4718             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2400">line 2400</a>
4719         </div>
4720
4721     </div>
4722
4723
4724 </dt>
4725 <dd>
4726
4727
4728     <div class="description">
4729         <p>Checks whether this logical interface is &quot;empty&quot;, meaning that ut
4730 has no network devices attached.</p>
4731     </div>
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741 <dl class="details">
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763 </dl>
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775     <h5>Returns:</h5>
4776
4777
4778
4779 <table class="params">
4780     <thead>
4781     <tr>
4782
4783         <th>Type</th>
4784         <th class="last">Description</th>
4785     </tr>
4786     </thead>
4787     <tbody>
4788
4789         <tr>
4790
4791             <td class="type">
4792
4793                         boolean
4794
4795
4796             </td>
4797             <td class="description last">Returns <code>true</code> if this logical interface is empty, else <code>false</code>.</td>
4798         </tr>
4799
4800     </tbody>
4801 </table>
4802
4803
4804
4805
4806 </dd>
4807
4808
4809
4810 <dt>
4811     <div class="nameContainer">
4812         <h4 class="name" id="isFloating">
4813
4814             isFloating<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
4815         </h4>
4816
4817
4818         <div class="tag-source">
4819             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2349">line 2349</a>
4820         </div>
4821
4822     </div>
4823
4824
4825 </dt>
4826 <dd>
4827
4828
4829     <div class="description">
4830         <p>Checks whether this protocol is &quot;floating&quot;.</p>
4831 <p>A &quot;floating&quot; protocol is a protocol which spawns its own interfaces
4832 on demand, like a virtual one but which relies on an existinf lower
4833 level interface to initiate the connection.</p>
4834 <p>An example for such a protocol is &quot;pppoe&quot;.</p>
4835 <p>This function exists for backwards compatibility with older code
4836 but should not be used anymore.</p>
4837     </div>
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847 <dl class="details">
4848
4849
4850
4851
4852
4853
4854
4855         <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871 </dl>
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883     <h5>Returns:</h5>
4884
4885
4886
4887 <table class="params">
4888     <thead>
4889     <tr>
4890
4891         <th>Type</th>
4892         <th class="last">Description</th>
4893     </tr>
4894     </thead>
4895     <tbody>
4896
4897         <tr>
4898
4899             <td class="type">
4900
4901                         boolean
4902
4903
4904             </td>
4905             <td class="description last">Returns a boolean indicating whether this protocol is floating (<code>true</code>)
4906 or not (<code>false</code>).</td>
4907         </tr>
4908
4909     </tbody>
4910 </table>
4911
4912
4913
4914
4915 </dd>
4916
4917
4918
4919 <dt>
4920     <div class="nameContainer">
4921         <h4 class="name" id="isInstalled">
4922
4923             <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>
4924         </h4>
4925
4926
4927         <div class="tag-source">
4928             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2308">line 2308</a>
4929         </div>
4930
4931     </div>
4932
4933
4934 </dt>
4935 <dd>
4936
4937
4938     <div class="description">
4939         <p>Checks whether the protocol functionality is installed.</p>
4940 <p>This function exists for compatibility with old code, it always
4941 returns <code>true</code>.</p>
4942     </div>
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952 <dl class="details">
4953
4954
4955
4956
4957
4958
4959
4960         <dt class="important tag-deprecated">Deprecated</dt><dd class="yes-def tag-deprecated"><ul class="dummy"><li>Yes</li></ul></dd>
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976 </dl>
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988     <h5>Returns:</h5>
4989
4990
4991
4992 <table class="params">
4993     <thead>
4994     <tr>
4995
4996         <th>Type</th>
4997         <th class="last">Description</th>
4998     </tr>
4999     </thead>
5000     <tbody>
5001
5002         <tr>
5003
5004             <td class="type">
5005
5006                         boolean
5007
5008
5009             </td>
5010             <td class="description last">Returns <code>true</code> if the protocol support is installed, else <code>false</code>.</td>
5011         </tr>
5012
5013     </tbody>
5014 </table>
5015
5016
5017
5018
5019 </dd>
5020
5021
5022
5023 <dt>
5024     <div class="nameContainer">
5025         <h4 class="name" id="isUp">
5026
5027             isUp<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
5028         </h4>
5029
5030
5031         <div class="tag-source">
5032             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2422">line 2422</a>
5033         </div>
5034
5035     </div>
5036
5037
5038 </dt>
5039 <dd>
5040
5041
5042     <div class="description">
5043         <p>Checks whether this logical interface is configured and running.</p>
5044     </div>
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054 <dl class="details">
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076 </dl>
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088     <h5>Returns:</h5>
5089
5090
5091
5092 <table class="params">
5093     <thead>
5094     <tr>
5095
5096         <th>Type</th>
5097         <th class="last">Description</th>
5098     </tr>
5099     </thead>
5100     <tbody>
5101
5102         <tr>
5103
5104             <td class="type">
5105
5106                         boolean
5107
5108
5109             </td>
5110             <td class="description last">Returns <code>true</code> when the interface is active or <code>false</code> when it is not.</td>
5111         </tr>
5112
5113     </tbody>
5114 </table>
5115
5116
5117
5118
5119 </dd>
5120
5121
5122
5123 <dt>
5124     <div class="nameContainer">
5125         <h4 class="name" id="isVirtual">
5126
5127             isVirtual<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span>
5128         </h4>
5129
5130
5131         <div class="tag-source">
5132             <a href="network.js.html">network.js</a>, <a href="network.js.html#line2328">line 2328</a>
5133         </div>
5134
5135     </div>
5136
5137
5138 </dt>
5139 <dd>
5140
5141
5142     <div class="description">
5143         <p>Checks whether this protocol is &quot;virtual&quot;.</p>
5144 <p>A &quot;virtual&quot; protocol is a protocol which spawns its own interfaces
5145 on demand instead of using existing physical interfaces.</p>
5146 <p>Examples for virtual protocols are <code>6in4</code> which <code>gre</code> spawn tunnel
5147 network device on startup, examples for non-virtual protcols are
5148 <code>dhcp</code> or <code>static</code> which apply IP configuration to existing interfaces.</p>
5149 <p>This function should be overwritten by subclasses.</p>
5150     </div>
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160 <dl class="details">
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182 </dl>
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194     <h5>Returns:</h5>
5195
5196
5197
5198 <table class="params">
5199     <thead>
5200     <tr>
5201
5202         <th>Type</th>
5203         <th class="last">Description</th>
5204     </tr>
5205     </thead>
5206     <tbody>
5207
5208         <tr>
5209
5210             <td class="type">
5211
5212                         boolean
5213
5214
5215             </td>
5216             <td class="description last">Returns a boolean indicating whether the underlying protocol spawns
5217 dynamic interfaces (<code>true</code>) or not (<code>false</code>).</td>
5218         </tr>
5219
5220     </tbody>
5221 </table>
5222
5223
5224
5225
5226 </dd>
5227
5228
5229
5230 <dt>
5231     <div class="nameContainer">
5232         <h4 class="name" id="set">
5233
5234             set<span class="signature">(opt, val)</span>
5235         </h4>
5236
5237
5238         <div class="tag-source">
5239             <a href="network.js.html">network.js</a>, <a href="network.js.html#line1897">line 1897</a>
5240         </div>
5241
5242     </div>
5243
5244
5245 </dt>
5246 <dd>
5247
5248
5249     <div class="description">
5250         <p>Set the given UCI option of this network to the given value.</p>
5251     </div>
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261 <table class="params">
5262     <thead>
5263         <tr>
5264
5265                 <th>Name</th>
5266
5267
5268                 <th>Type</th>
5269
5270
5271
5272                 <th class="last">Description</th>
5273         </tr>
5274         </thead>
5275
5276         <tbody>
5277
5278
5279         <tr>
5280
5281                 <td class="name"><code>opt</code></td>
5282
5283
5284             <td class="type">
5285
5286
5287 <span class="param-type">string</span>
5288
5289
5290
5291             </td>
5292
5293
5294
5295             <td class="description last">
5296
5297                 <p>The name of the UCI option to set.</p></td>
5298         </tr>
5299
5300
5301
5302         <tr>
5303
5304                 <td class="name"><code>val</code></td>
5305
5306
5307             <td class="type">
5308
5309
5310 <span class="param-type">null</span>
5311 |
5312
5313 <span class="param-type">string</span>
5314 |
5315
5316 <span class="param-type">Array.&lt;string></span>
5317
5318
5319
5320             </td>
5321
5322
5323
5324             <td class="description last">
5325
5326                 <p>The value to set or <code>null</code> to remove the given option from the
5327 configuration.</p></td>
5328         </tr>
5329
5330
5331         </tbody>
5332 </table>
5333
5334
5335
5336 <dl class="details">
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358 </dl>
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372 </dd>
5373
5374         </dl>
5375
5376
5377
5378
5379
5380
5381
5382 </article>
5383
5384 </section>
5385
5386
5387
5388
5389
5390
5391
5392         <footer>
5393             Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:06 GMT+0100 (Central European Standard Time)
5394         </footer>
5395     </div>
5396 </div>
5397 <script>prettyPrint();</script>
5398 <script src="scripts/jaguar.js"></script>
5399 </body>
5400 </html>