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