From baa727de93db009f90d70a80a9861758a24eae77 Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 10:27:59 +0100 Subject: docs: rename documentation folder to docs Signed-off-by: Jo-Philipp Wich --- documentation/jsapi/LuCI.Network.Hosts.html | 2421 --------------------------- 1 file changed, 2421 deletions(-) delete mode 100644 documentation/jsapi/LuCI.Network.Hosts.html (limited to 'documentation/jsapi/LuCI.Network.Hosts.html') diff --git a/documentation/jsapi/LuCI.Network.Hosts.html b/documentation/jsapi/LuCI.Network.Hosts.html deleted file mode 100644 index fc392d8802..0000000000 --- a/documentation/jsapi/LuCI.Network.Hosts.html +++ /dev/null @@ -1,2421 +0,0 @@ - - - - - Class: Hosts - - - - - - - - - - - - - - - - - -
- -
-

- -
- -
- -
-
-

Class: Hosts

- - - - -
- -
-

- LuCI.Network. - - Hosts -

- -

The LuCI.Network.Hosts class encapsulates host information aggregated -from multiple sources and provides convenience functions to access the -host information by different criteria.

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

- - new LuCI.Network.Hosts() -

- - -
- network.js, line 1628 -
- -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

- - getHostnameByIP6Addr(ipaddr){null|string} -

- - -
- network.js, line 1725 -
- -
- - -
-
- - -
-

Lookup the hostname associated with the given IPv6 address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipaddr - - -string - - - - - -

The IPv6 address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the hostname associated with the given IPv6 or null if -no matching host could be found or if no hostname is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getHostnameByIPAddr(ipaddr){null|string} -

- - -
- network.js, line 1689 -
- -
- - -
-
- - -
-

Lookup the hostname associated with the given IPv4 address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipaddr - - -string - - - - - -

The IPv4 address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the hostname associated with the given IPv4 or null if -no matching host could be found or if no hostname is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getHostnameByMACAddr(mac){null|string} -

- - -
- network.js, line 1644 -
- -
- - -
-
- - -
-

Lookup the hostname associated with the given MAC address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mac - - -string - - - - - -

The MAC address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the hostname associated with the given MAC or null if -no matching host could be found or if no hostname is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getIP6AddrByMACAddr(mac){null|string} -

- - -
- network.js, line 1674 -
- -
- - -
-
- - -
-

Lookup the IPv6 address associated with the given MAC address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mac - - -string - - - - - -

The MAC address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the IPv6 address associated with the given MAC or null if -no matching host could be found or if no IPv6 address is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getIPAddrByMACAddr(mac){null|string} -

- - -
- network.js, line 1659 -
- -
- - -
-
- - -
-

Lookup the IPv4 address associated with the given MAC address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
mac - - -string - - - - - -

The MAC address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the IPv4 address associated with the given MAC or null if -no matching host could be found or if no IPv4 address is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getMACAddrByIP6Addr(ipaddr){null|string} -

- - -
- network.js, line 1743 -
- -
- - -
-
- - -
-

Lookup the MAC address associated with the given IPv6 address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipaddr - - -string - - - - - -

The IPv6 address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the MAC address associated with the given IPv6 or null if -no matching host could be found or if no MAC address is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getMACAddrByIPAddr(ipaddr){null|string} -

- - -
- network.js, line 1707 -
- -
- - -
-
- - -
-

Lookup the MAC address associated with the given IPv4 address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
ipaddr - - -string - - - - - -

The IPv4 address to lookup.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the MAC address associated with the given IPv4 or null if -no matching host could be found or if no MAC address is known for -the corresponding host.
- - - - -
- - - -
-
-

- - getMACHints(preferIp6){Array.<Array.<string>>} -

- - -
- network.js, line 1771 -
- -
- - -
-
- - -
-

Return an array of (MAC address, name hint) tuples sorted by -MAC address.

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDefaultDescription
preferIp6 - - -boolean - - - - - - false - - - - - optional - - - - - -

Whether to prefer IPv6 addresses (true) or IPv4 addresses (false) -as name hint when no hostname is known for a specific MAC address.

- - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Array.<Array.<string>> - - - Returns an array of arrays containing a name hint for each found -MAC address on the system. The array is sorted ascending by MAC. -Each item of the resulting array is a two element array with the -MAC being the first element and the name hint being the second -element. The name hint is either the hostname, an IPv4 or an IPv6 -address related to the MAC address. -If no hostname but both IPv4 and IPv6 addresses are known, the -preferIP6 flag specifies whether the IPv6 or the IPv4 address -is used as hint.
- - - - -
- -
- - - - - - - -
- -
- - - - - - - -
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) -
-
-
- - - - \ No newline at end of file -- cgit v1.2.3