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