5 <title>Source: rpc.js</title>
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>
12 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
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">
20 var config = {"monospaceLinks":true,"cleverLinks":true,"default":{"outputSourceFiles":true}};
27 <div id="wrap" class="clearfix">
29 <div class="navigation">
30 <h3 class="applicationName"><a href="index.html"></a></h3>
33 <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations">
37 <li class="item" data-name="LuCI">
39 <a href="LuCI.html">LuCI</a>
42 <ul class="members itemMembers">
44 <span class="subtitle">Members</span>
46 <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li>
49 <ul class="typedefs itemMembers">
51 <span class="subtitle">Typedefs</span>
53 <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li>
56 <ul class="typedefs itemMembers">
59 <ul class="methods itemMembers">
61 <span class="subtitle">Methods</span>
63 <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li>
65 <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li>
67 <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li>
69 <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li>
71 <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li>
73 <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li>
75 <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li>
77 <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li>
79 <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li>
81 <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li>
83 <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li>
85 <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li>
87 <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li>
89 <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li>
91 <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li>
93 <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li>
95 <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li>
97 <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li>
99 <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li>
102 <ul class="events itemMembers">
107 <li class="item" data-name="LuCI.Class">
109 <a href="LuCI.Class.html">LuCI.Class</a>
112 <ul class="members itemMembers">
115 <ul class="typedefs itemMembers">
118 <ul class="typedefs itemMembers">
121 <ul class="methods itemMembers">
123 <span class="subtitle">Methods</span>
125 <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li>
127 <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li>
129 <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li>
131 <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li>
133 <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li>
135 <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li>
138 <ul class="events itemMembers">
143 <li class="item" data-name="LuCI.dom">
145 <a href="LuCI.dom.html">LuCI.dom</a>
148 <ul class="members itemMembers">
151 <ul class="typedefs itemMembers">
153 <span class="subtitle">Typedefs</span>
155 <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li>
158 <ul class="typedefs itemMembers">
161 <ul class="methods itemMembers">
163 <span class="subtitle">Methods</span>
165 <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li>
167 <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li>
169 <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li>
171 <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li>
173 <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li>
175 <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li>
177 <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li>
179 <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li>
181 <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li>
183 <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li>
185 <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li>
187 <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li>
189 <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li>
192 <ul class="events itemMembers">
197 <li class="item" data-name="LuCI.fs">
199 <a href="LuCI.fs.html">LuCI.fs</a>
202 <ul class="members itemMembers">
205 <ul class="typedefs itemMembers">
207 <span class="subtitle">Typedefs</span>
209 <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li>
211 <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li>
214 <ul class="typedefs itemMembers">
217 <ul class="methods itemMembers">
219 <span class="subtitle">Methods</span>
221 <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li>
223 <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li>
225 <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li>
227 <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li>
229 <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li>
231 <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li>
233 <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li>
235 <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li>
238 <ul class="events itemMembers">
243 <li class="item" data-name="LuCI.Headers">
245 <a href="LuCI.Headers.html">LuCI.Headers</a>
248 <ul class="members itemMembers">
251 <ul class="typedefs itemMembers">
254 <ul class="typedefs itemMembers">
257 <ul class="methods itemMembers">
259 <span class="subtitle">Methods</span>
261 <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li>
263 <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li>
266 <ul class="events itemMembers">
271 <li class="item" data-name="LuCI.Network">
273 <a href="LuCI.Network.html">LuCI.Network</a>
276 <ul class="members itemMembers">
279 <ul class="typedefs itemMembers">
281 <span class="subtitle">Typedefs</span>
283 <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li>
285 <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li>
287 <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li>
289 <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li>
291 <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li>
294 <ul class="typedefs itemMembers">
297 <ul class="methods itemMembers">
299 <span class="subtitle">Methods</span>
301 <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li>
303 <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li>
305 <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li>
307 <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
309 <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li>
311 <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li>
313 <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li>
315 <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li>
317 <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li>
319 <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li>
321 <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li>
323 <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li>
325 <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li>
327 <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li>
329 <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li>
331 <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li>
333 <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li>
335 <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li>
337 <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li>
339 <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li>
341 <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li>
343 <li data-name="LuCI.Network#getWifiNetworks"><a href="LuCI.Network.html#getWifiNetworks">getWifiNetworks</a></li>
345 <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li>
347 <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li>
349 <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li>
351 <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li>
353 <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li>
355 <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li>
357 <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li>
360 <ul class="events itemMembers">
365 <li class="item" data-name="LuCI.Network.Device">
367 <a href="LuCI.Network.Device.html">LuCI.Network.Device</a>
370 <ul class="members itemMembers">
373 <ul class="typedefs itemMembers">
376 <ul class="typedefs itemMembers">
379 <ul class="methods itemMembers">
381 <span class="subtitle">Methods</span>
383 <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li>
385 <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li>
387 <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li>
389 <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li>
391 <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li>
393 <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li>
395 <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li>
397 <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li>
399 <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li>
401 <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li>
403 <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li>
405 <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li>
407 <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li>
409 <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li>
411 <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li>
413 <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li>
415 <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li>
417 <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li>
419 <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li>
421 <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li>
423 <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li>
425 <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li>
428 <ul class="events itemMembers">
433 <li class="item" data-name="LuCI.Network.Hosts">
435 <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>
438 <ul class="members itemMembers">
441 <ul class="typedefs itemMembers">
444 <ul class="typedefs itemMembers">
447 <ul class="methods itemMembers">
449 <span class="subtitle">Methods</span>
451 <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li>
453 <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li>
455 <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li>
457 <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li>
459 <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li>
461 <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li>
463 <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li>
465 <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li>
468 <ul class="events itemMembers">
473 <li class="item" data-name="LuCI.Network.Protocol">
475 <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>
478 <ul class="members itemMembers">
481 <ul class="typedefs itemMembers">
484 <ul class="typedefs itemMembers">
487 <ul class="methods itemMembers">
489 <span class="subtitle">Methods</span>
491 <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li>
493 <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li>
495 <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li>
497 <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li>
499 <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li>
501 <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li>
503 <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li>
505 <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li>
507 <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li>
509 <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li>
511 <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li>
513 <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li>
515 <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li>
517 <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li>
519 <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li>
521 <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li>
523 <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li>
525 <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li>
527 <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li>
529 <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li>
531 <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li>
533 <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li>
535 <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li>
537 <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li>
539 <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li>
541 <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li>
543 <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li>
545 <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li>
547 <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li>
549 <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li>
551 <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li>
553 <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li>
555 <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li>
557 <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li>
559 <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li>
561 <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li>
563 <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li>
565 <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li>
568 <ul class="events itemMembers">
573 <li class="item" data-name="LuCI.Network.WifiDevice">
575 <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>
578 <ul class="members itemMembers">
581 <ul class="typedefs itemMembers">
584 <ul class="typedefs itemMembers">
587 <ul class="methods itemMembers">
589 <span class="subtitle">Methods</span>
591 <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li>
593 <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li>
595 <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li>
597 <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li>
599 <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li>
601 <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li>
603 <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li>
605 <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li>
607 <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li>
609 <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li>
611 <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li>
613 <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li>
615 <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li>
618 <ul class="events itemMembers">
623 <li class="item" data-name="LuCI.Network.WifiNetwork">
625 <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>
628 <ul class="members itemMembers">
631 <ul class="typedefs itemMembers">
634 <ul class="typedefs itemMembers">
637 <ul class="methods itemMembers">
639 <span class="subtitle">Methods</span>
641 <li data-name="LuCI.Network.WifiNetwork#disconnectClient"><a href="LuCI.Network.WifiNetwork.html#disconnectClient">disconnectClient</a></li>
643 <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li>
645 <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li>
647 <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li>
649 <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li>
651 <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li>
653 <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li>
655 <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li>
657 <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li>
659 <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li>
661 <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li>
663 <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li>
665 <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li>
667 <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li>
669 <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li>
671 <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li>
673 <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li>
675 <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li>
677 <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li>
679 <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li>
681 <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li>
683 <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li>
685 <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li>
687 <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li>
689 <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li>
691 <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li>
693 <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li>
695 <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li>
697 <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li>
699 <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li>
701 <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li>
703 <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li>
705 <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li>
707 <li data-name="LuCI.Network.WifiNetwork#isClientDisconnectSupported"><a href="LuCI.Network.WifiNetwork.html#isClientDisconnectSupported">isClientDisconnectSupported</a></li>
709 <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li>
711 <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li>
713 <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li>
716 <ul class="events itemMembers">
721 <li class="item" data-name="LuCI.Poll">
723 <a href="LuCI.Poll.html">LuCI.Poll</a>
726 <ul class="members itemMembers">
729 <ul class="typedefs itemMembers">
732 <ul class="typedefs itemMembers">
735 <ul class="methods itemMembers">
737 <span class="subtitle">Methods</span>
739 <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li>
741 <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li>
743 <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li>
745 <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li>
747 <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li>
750 <ul class="events itemMembers">
755 <li class="item" data-name="LuCI.Request">
757 <a href="LuCI.Request.html">LuCI.Request</a>
760 <ul class="members itemMembers">
763 <ul class="typedefs itemMembers">
765 <span class="subtitle">Typedefs</span>
767 <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li>
769 <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li>
772 <ul class="typedefs itemMembers">
775 <ul class="methods itemMembers">
777 <span class="subtitle">Methods</span>
779 <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li>
781 <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li>
783 <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li>
785 <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li>
787 <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li>
789 <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li>
792 <ul class="events itemMembers">
797 <li class="item" data-name="LuCI.Request.poll">
799 <a href="LuCI.Request.poll.html">LuCI.Request.poll</a>
802 <ul class="members itemMembers">
805 <ul class="typedefs itemMembers">
807 <span class="subtitle">Typedefs</span>
809 <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li>
812 <ul class="typedefs itemMembers">
815 <ul class="methods itemMembers">
817 <span class="subtitle">Methods</span>
819 <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li>
821 <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li>
823 <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li>
825 <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li>
827 <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li>
830 <ul class="events itemMembers">
835 <li class="item" data-name="LuCI.Response">
837 <a href="LuCI.Response.html">LuCI.Response</a>
840 <ul class="members itemMembers">
842 <span class="subtitle">Members</span>
844 <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li>
846 <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li>
848 <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li>
850 <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li>
852 <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li>
854 <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li>
857 <ul class="typedefs itemMembers">
860 <ul class="typedefs itemMembers">
863 <ul class="methods itemMembers">
865 <span class="subtitle">Methods</span>
867 <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li>
869 <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li>
871 <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li>
874 <ul class="events itemMembers">
879 <li class="item" data-name="LuCI.rpc">
881 <a href="LuCI.rpc.html">LuCI.rpc</a>
884 <ul class="members itemMembers">
887 <ul class="typedefs itemMembers">
889 <span class="subtitle">Typedefs</span>
891 <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li>
893 <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li>
895 <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li>
897 <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li>
900 <ul class="typedefs itemMembers">
903 <ul class="methods itemMembers">
905 <span class="subtitle">Methods</span>
907 <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li>
909 <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li>
911 <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li>
913 <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li>
915 <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li>
917 <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li>
919 <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li>
921 <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li>
923 <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li>
926 <ul class="events itemMembers">
931 <li class="item" data-name="LuCI.uci">
933 <a href="LuCI.uci.html">LuCI.uci</a>
936 <ul class="members itemMembers">
939 <ul class="typedefs itemMembers">
941 <span class="subtitle">Typedefs</span>
943 <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li>
945 <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li>
947 <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li>
950 <ul class="typedefs itemMembers">
953 <ul class="methods itemMembers">
955 <span class="subtitle">Methods</span>
957 <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li>
959 <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li>
961 <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li>
963 <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li>
965 <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li>
967 <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li>
969 <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li>
971 <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li>
973 <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li>
975 <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li>
977 <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li>
979 <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li>
981 <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li>
983 <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li>
985 <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li>
987 <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li>
989 <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li>
992 <ul class="events itemMembers">
997 <li class="item" data-name="LuCI.view">
999 <a href="LuCI.view.html">LuCI.view</a>
1002 <ul class="members itemMembers">
1005 <ul class="typedefs itemMembers">
1008 <ul class="typedefs itemMembers">
1011 <ul class="methods itemMembers">
1013 <span class="subtitle">Methods</span>
1015 <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li>
1017 <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li>
1019 <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li>
1021 <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li>
1023 <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li>
1025 <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li>
1028 <ul class="events itemMembers">
1033 <li class="item" data-name="LuCI.XHR">
1034 <span class="title">
1035 <a href="LuCI.XHR.html">LuCI.XHR</a>
1038 <ul class="members itemMembers">
1041 <ul class="typedefs itemMembers">
1044 <ul class="typedefs itemMembers">
1047 <ul class="methods itemMembers">
1049 <span class="subtitle">Methods</span>
1051 <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li>
1053 <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li>
1055 <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li>
1057 <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li>
1059 <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li>
1061 <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li>
1064 <ul class="events itemMembers">
1072 <h1 class="page-title" data-filename="rpc.js.html">Source: rpc.js</h1>
1079 <pre id="source-code" class="prettyprint source "><code>'use strict';
1081 var rpcRequestID = 1,
1082 rpcSessionID = L.env.sessionid || '00000000000000000000000000000000',
1083 rpcBaseURL = L.url('admin/ubus'),
1084 rpcInterceptorFns = [];
1092 * The `LuCI.rpc` class provides high level ubus JSON-RPC abstractions
1093 * and means for listing and invoking remove RPC methods.
1095 return L.Class.extend(/** @lends LuCI.rpc.prototype */ {
1097 call: function(req, cb, nobatch) {
1100 if (Array.isArray(req)) {
1101 if (req.length == 0)
1102 return Promise.resolve([]);
1104 for (var i = 0; i < req.length; i++)
1106 q += '%s%s.%s'.format(
1112 else if (req.params) {
1113 q += '/%s.%s'.format(req.params[1], req.params[2]);
1116 return L.Request.post(rpcBaseURL + q, req, {
1117 timeout: (L.env.rpctimeout || 20) * 1000,
1123 parseCallReply: function(req, res) {
1126 if (res instanceof Error)
1127 return req.reject(res);
1131 L.raise('RPCError', 'RPC call to %s/%s failed with HTTP error %d: %s',
1132 req.object, req.method, res.status, res.statusText || '?');
1137 return req.reject(e);
1141 * The interceptor args are intentionally swapped.
1142 * Response is passed as first arg to align with Request class interceptors
1144 Promise.all(rpcInterceptorFns.map(function(fn) { return fn(msg, req) }))
1145 .then(this.handleCallReply.bind(this, req, msg))
1149 handleCallReply: function(req, msg) {
1150 var type = Object.prototype.toString,
1154 /* verify message frame */
1155 if (!L.isObject(msg) || msg.jsonrpc != '2.0')
1156 L.raise('RPCError', 'RPC call to %s/%s returned invalid message frame',
1157 req.object, req.method);
1159 /* check error condition */
1160 if (L.isObject(msg.error) && msg.error.code && msg.error.message)
1161 L.raise('RPCError', 'RPC call to %s/%s failed with error %d: %s',
1162 req.object, req.method, msg.error.code, msg.error.message || '?');
1165 return req.reject(e);
1168 if (!req.object && !req.method) {
1171 else if (Array.isArray(msg.result)) {
1172 ret = (msg.result.length > 1) ? msg.result[1] : msg.result[0];
1176 for (var key in req.expect) {
1177 if (ret != null && key != '')
1180 if (ret == null || type.call(ret) != type.call(req.expect[key]))
1181 ret = req.expect[key];
1188 if (typeof(req.filter) == 'function') {
1190 req.priv[1] = req.params;
1191 ret = req.filter.apply(this, req.priv);
1198 * Lists available remote ubus objects or the method signatures of
1201 * This function has two signatures and is sensitive to the number of
1202 * arguments passed to it:
1204 * Returns an array containing the names of all remote `ubus` objects
1205 * - `list("objname", ...)`
1206 * Returns method signatures for each given `ubus` object name.
1208 * @param {...string} [objectNames]
1209 * If any object names are given, this function will return the method
1210 * signatures of each given object.
1212 * @returns {Promise<Array<string>|Object<string, Object<string, Object<string, string>>>>}
1213 * When invoked without arguments, this function will return a promise
1214 * resolving to an array of `ubus` object names. When invoked with one or
1215 * more arguments, a promise resolving to an object describing the method
1216 * signatures of each requested `ubus` object name will be returned.
1223 params: arguments.length ? this.varargs(arguments) : undefined
1226 return new Promise(L.bind(function(resolveFn, rejectFn) {
1227 /* store request info */
1234 this.call(msg, this.parseCallReply.bind(this, req));
1239 * @typedef {Object} DeclareOptions
1240 * @memberof LuCI.rpc
1242 * @property {string} object
1243 * The name of the remote `ubus` object to invoke.
1245 * @property {string} method
1246 * The name of the remote `ubus` method to invoke.
1248 * @property {string[]} [params]
1249 * Lists the named parameters expected by the remote `ubus` RPC method.
1250 * The arguments passed to the resulting generated method call function
1251 * will be mapped to named parameters in the order they appear in this
1254 * Extraneous parameters passed to the generated function will not be
1255 * sent to the remote procedure but are passed to the
1256 * {@link LuCI.rpc~filterFn filter function} if one is specified.
1259 * - `params: [ "foo", "bar" ]` -
1260 * When the resulting call function is invoked with `fn(true, false)`,
1261 * the corresponding args object sent to the remote procedure will be
1262 * `{ foo: true, bar: false }`.
1263 * - `params: [ "test" ], filter: function(reply, args, extra) { ... }` -
1264 * When the resultung generated function is invoked with
1265 * `fn("foo", "bar", "baz")` then `{ "test": "foo" }` will be sent as
1266 * argument to the remote procedure and the filter function will be
1267 * invoked with `filterFn(reply, [ "foo" ], "bar", "baz")`
1269 * @property {Object<string,*>} [expect]
1270 * Describes the expected return data structure. The given object is
1271 * supposed to contain a single key selecting the value to use from
1272 * the returned `ubus` reply object. The value of the sole key within
1273 * the `expect` object is used to infer the expected type of the received
1274 * `ubus` reply data.
1276 * If the received data does not contain `expect`'s key, or if the
1277 * type of the data differs from the type of the value in the expect
1278 * object, the expect object's value is returned as default instead.
1280 * The key in the `expect` object may be an empty string (`''`) in which
1281 * case the entire reply object is selected instead of one of its subkeys.
1283 * If the `expect` option is omitted, the received reply will be returned
1284 * as-is, regardless of its format or type.
1287 * - `expect: { '': { error: 'Invalid response' } }` -
1288 * This requires the entire `ubus` reply to be a plain JavaScript
1289 * object. If the reply isn't an object but e.g. an array or a numeric
1290 * error code instead, it will get replaced with
1291 * `{ error: 'Invalid response' }` instead.
1292 * - `expect: { results: [] }` -
1293 * This requires the received `ubus` reply to be an object containing
1294 * a key `results` with an array as value. If the received reply does
1295 * not contain such a key, or if `reply.results` points to a non-array
1296 * value, the empty array (`[]`) will be used instead.
1297 * - `expect: { success: false }` -
1298 * This requires the received `ubus` reply to be an object containing
1299 * a key `success` with a boolean value. If the reply does not contain
1300 * `success` or if `reply.success` is not a boolean value, `false` will
1301 * be returned as default instead.
1303 * @property {LuCI.rpc~filterFn} [filter]
1304 * Specfies an optional filter function which is invoked to transform the
1305 * received reply data before it is returned to the caller.
1310 * The filter function is invoked to transform a received `ubus` RPC call
1311 * reply before returning it to the caller.
1313 * @callback LuCI.rpc~filterFn
1316 * The received `ubus` reply data or a subset of it as described in the
1317 * `expect` option of the RPC call declaration. In case of remote call
1318 * errors, `data` is numeric `ubus` error code instead.
1320 * @param {Array<*>} args
1321 * The arguments the RPC method has been invoked with.
1323 * @param {...*} extraArgs
1324 * All extraneous arguments passed to the RPC method exceeding the number
1325 * of arguments describes in the RPC call declaration.
1328 * The return value of the filter function will be returned to the caller
1329 * of the RPC method as-is.
1333 * The generated invocation function is returned by
1334 * {@link LuCI.rpc#declare rpc.declare()} and encapsulates a single
1337 * Calling this function will execute a remote `ubus` HTTP call request
1338 * using the arguments passed to it as arguments and return a promise
1339 * resolving to the received reply values.
1341 * @callback LuCI.rpc~invokeFn
1343 * @param {...*} params
1344 * The parameters to pass to the remote procedure call. The given
1345 * positional arguments will be named to named RPC parameters according
1346 * to the names specified in the `params` array of the method declaration.
1348 * Any additional parameters exceeding the amount of arguments in the
1349 * `params` declaration are passed as private extra arguments to the
1350 * declared filter function.
1352 * @return {Promise<*>}
1353 * Returns a promise resolving to the result data of the remote `ubus`
1354 * RPC method invocation, optionally substituted and filtered according
1355 * to the `expect` and `filter` declarations.
1359 * Describes a remote RPC call procedure and returns a function
1362 * @param {LuCI.rpc.DeclareOptions} options
1363 * If any object names are given, this function will return the method
1364 * signatures of each given object.
1366 * @returns {LuCI.rpc~invokeFn}
1367 * Returns a new function implementing the method call described in
1370 declare: function(options) {
1371 return Function.prototype.bind.call(function(rpc, options) {
1372 var args = this.varargs(arguments, 2);
1373 return new Promise(function(resolveFn, rejectFn) {
1374 /* build parameter object */
1377 if (Array.isArray(options.params))
1378 for (p_off = 0; p_off < options.params.length; p_off++)
1379 params[options.params[p_off]] = args[p_off];
1381 /* all remaining arguments are private args */
1382 var priv = [ undefined, undefined ];
1383 for (; p_off < args.length; p_off++)
1384 priv.push(args[p_off]);
1386 /* store request info */
1388 expect: options.expect,
1389 filter: options.filter,
1394 object: options.object,
1395 method: options.method
1398 /* build message object */
1412 rpc.call(msg, rpc.parseCallReply.bind(rpc, req), options.nobatch);
1414 }, this, this, options);
1418 * Returns the current RPC session id.
1421 * Returns the 32 byte session ID string used for authenticating remote
1424 getSessionID: function() {
1425 return rpcSessionID;
1429 * Set the RPC session id to use.
1431 * @param {string} sid
1432 * Sets the 32 byte session ID string used for authenticating remote
1435 setSessionID: function(sid) {
1440 * Returns the current RPC base URL.
1443 * Returns the RPC URL endpoint to issue requests against.
1445 getBaseURL: function() {
1450 * Set the RPC base URL to use.
1452 * @param {string} sid
1453 * Sets the RPC URL endpoint to issue requests against.
1455 setBaseURL: function(url) {
1460 * Translates a numeric `ubus` error code into a human readable
1463 * @param {number} statusCode
1464 * The numeric status code.
1467 * Returns the textual description of the code.
1469 getStatusText: function(statusCode) {
1470 switch (statusCode) {
1471 case 0: return _('Command OK');
1472 case 1: return _('Invalid command');
1473 case 2: return _('Invalid argument');
1474 case 3: return _('Method not found');
1475 case 4: return _('Resource not found');
1476 case 5: return _('No data received');
1477 case 6: return _('Permission denied');
1478 case 7: return _('Request timeout');
1479 case 8: return _('Not supported');
1480 case 9: return _('Unspecified error');
1481 case 10: return _('Connection lost');
1482 default: return _('Unknown error code');
1487 * Registered interceptor functions are invoked before the standard reply
1488 * parsing and handling logic.
1490 * By returning rejected promises, interceptor functions can cause the
1491 * invocation function to fail, regardless of the received reply.
1493 * Interceptors may also modify their message argument in-place to
1494 * rewrite received replies before they're processed by the standard
1495 * response handling code.
1497 * A common use case for such functions is to detect failing RPC replies
1498 * due to expired authentication in order to trigger a new login.
1500 * @callback LuCI.rpc~interceptorFn
1503 * The unprocessed, JSON decoded remote RPC method call reply.
1505 * Since interceptors run before the standard parsing logic, the reply
1506 * data is not verified for correctness or filtered according to
1507 * `expect` and `filter` specifications in the declarations.
1509 * @param {Object} req
1510 * The related request object which is an extended variant of the
1511 * declaration object, allowing access to internals of the invocation
1512 * function such as `filter`, `expect` or `params` values.
1514 * @return {Promise<*>|*}
1515 * Interceptor functions may return a promise to defer response
1516 * processing until some delayed work completed. Any values the returned
1517 * promise resolves to are ignored.
1519 * When the returned promise rejects with an error, the invocation
1520 * function will fail too, forwarding the error to the caller.
1524 * Registers a new interceptor function.
1526 * @param {LuCI.rpc~interceptorFn} interceptorFn
1527 * The inteceptor function to register.
1529 * @returns {LuCI.rpc~interceptorFn}
1530 * Returns the given function value.
1532 addInterceptor: function(interceptorFn) {
1533 if (typeof(interceptorFn) == 'function')
1534 rpcInterceptorFns.push(interceptorFn);
1535 return interceptorFn;
1539 * Removes a registered interceptor function.
1541 * @param {LuCI.rpc~interceptorFn} interceptorFn
1542 * The inteceptor function to remove.
1544 * @returns {boolean}
1545 * Returns `true` if the given function has been removed or `false`
1546 * if it has not been found.
1548 removeInterceptor: function(interceptorFn) {
1549 var oldlen = rpcInterceptorFns.length, i = oldlen;
1551 if (rpcInterceptorFns[i] === interceptorFn)
1552 rpcInterceptorFns.splice(i, 1);
1553 return (rpcInterceptorFns.length < oldlen);
1568 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Nov 07 2019 12:36:05 GMT+0100 (Central European Standard Time)
1572 <script>prettyPrint();</script>
1573 <script src="scripts/jaguar.js"></script>