Class: poll

- -

- LuCI .Request. - - poll -

- -

The Request.poll class provides some convience wrappers around -LuCI.Poll mainly to simplify registering repeating HTTP -request calls as polling functions.

- -

- - - - -

- - new LuCI.Request.poll() -

- - -

- luci.js, line 928 -

- -

- - -

- - - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - -

- - - - - - - - - - - - - - -

Methods

- -

- - - - active() - - - - - luci.js, line 1032 - - - - - -

- - -

Alias for LuCI.Poll.active().

- - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - add(interval, url, options, callback){function} - - - - - luci.js, line 971 - - - - - -

- - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Description
`interval`	- - -number - - - -	- - - - - - - The poll interval in seconds.
`url`	- - -string - - - -	- - - - - - - The URL to request on each poll.
`options`	- - -LuCI.Request.RequestOptions - - - -	- - - optional - - - - - - Additional options to configure the request.
`callback`	- - -LuCI.Request.poll~callbackFn - - - -	- - - optional - - - - - - `Callback` function to -invoke for each HTTP reply.

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Throws:

- - - -

- - Throws TypeError when an invalid interval was passed. - -
- - - Type - - - -TypeError - - - - -

- - - - - -

Returns:

- - - - - - - - - - - - - - - - - - - - -

Type	Description
- - function - - -	Returns the internally created poll function.

- - - - -

- - - - remove(entry){boolean} - - - - - luci.js, line 1008 - - - - - -

- - -

Remove a polling request that has been previously added using add(). -This function is essentially a wrapper around -LuCI.Poll.remove().

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Description
`entry`	- - -function - - - -	- - The poll function returned by `add()`.

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Returns:

- - - - - - - - - - - - - - - - - - - - -

Type	Description
- - boolean - - -	Returns `true` if any function has been removed, else `false`.

- - - - -

- - - - start() - - - - - luci.js, line 1016 - - - - - -

- - -

Alias for LuCI.Poll.start().

- - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - stop() - - - - - luci.js, line 1024 - - - - - -

- - -

Alias for LuCI.Poll.stop().

- - - - - - - - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - -

Type Definitions

- -

- - - - callbackFn(res, data, duration) - - - - - luci.js, line 929 - - - - - -

- - -

The callback function is invoked whenever an HTTP reply to a -polled request is received or when the polled request timed -out.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Name	Type	Description
`res`	- - -LuCI.Response - - - -	- - The HTTP response object.
`data`	- - -* - - - -	- - The response JSON if the response could be parsed as such, -else `null`.
`duration`	- - -number - - - -	- - The total duration of the request in milliseconds.

- - - -

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

- - - - - -

- -