From 355a48866d1a43df9443a3b559c8ec8642343f3a Mon Sep 17 00:00:00 2001 From: Jo-Philipp Wich Date: Tue, 5 Nov 2019 10:18:51 +0100 Subject: documentation: change JS docs template Use another template for the JS api documentation which provides a better overview over the classes and methods. Signed-off-by: Jo-Philipp Wich --- documentation/jsapi/LuCI.Network.Hosts.html | 2831 ++++++++++++++++++--------- 1 file changed, 1874 insertions(+), 957 deletions(-) (limited to 'documentation/jsapi/LuCI.Network.Hosts.html') diff --git a/documentation/jsapi/LuCI.Network.Hosts.html b/documentation/jsapi/LuCI.Network.Hosts.html index f98641bb74..fc392d8802 100644 --- a/documentation/jsapi/LuCI.Network.Hosts.html +++ b/documentation/jsapi/LuCI.Network.Hosts.html @@ -1,194 +1,1233 @@ - + - JSDoc: Class: Hosts - - - + Class: Hosts + + + + + - - + + + + + + + + +
+ +
+

-
- -

Class: Hosts

- +
+ +
+ +
+
+

Class: Hosts

+
- +
+

+ LuCI.Network. -

- LuCI.Network.Hosts

- -

The LuCI.Network.Hosts class encapsulates host information aggregated + 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 +
+ +
+ +
+
+ + - - - - - - - - - - - - - + + + + + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + - - - - - - - - - - - - - - - - + + + + + + + +
- - - - - - - - + + + + + +

Methods

- +
- +
+
+

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

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

getHostnameByIP6Addr(ipaddr) → {null|string}

+
+
- + +
+

Lookup the hostname associated with the given IPv6 address.

+
- - -
-

Lookup the hostname associated with the given IPv6 address.

-
- - - - - - - - - -
Parameters:
+ + + + + - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
NameTypeDescription
ipaddr @@ -197,162 +1236,148 @@ host information by different criteria.

The IPv6 address to lookup.

 + +

The IPv6 address to lookup.
- - - - - - + + +
- - + + + - - - - - - - - - - -
Source:
-
- - -
- - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
-
- - - - - - - - + -

getHostnameByIPAddr(ipaddr) → {null|string}

- - - - -
-

Lookup the hostname associated with the given IPv4 address.

-
- - - - - - - - - -
Parameters:
+ +
Returns:
+ + - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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 +
+ +
- Description - - + +
+
+ + +
+

Lookup the hostname associated with the given IPv4 address.

+
+ - + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
ipaddr @@ -361,326 +1386,298 @@ the corresponding host.

The IPv4 address to lookup.

 + +

The IPv4 address to lookup.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getHostnameByMACAddr(mac) → {null|string}

- - - - -
-

Lookup the hostname associated with the given MAC address.

-
- - - - - - - - - -
Parameters:
+ + +
Returns:
+ - - - - - - - - - - - - - - - - - - - + -
NameTypeDescription
mac - -string - - - + null + | + + string + +

The MAC address to lookup.

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.

+ + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getIP6AddrByMACAddr(mac) → {null|string}

- - - - -
-

Lookup the IPv6 address associated with the given MAC address.

-
- - - - - - - - - -
Parameters:
+ +
Returns:
+ + - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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 +
+ +
- Description - - + +
+
+ + +
+

Lookup the IPv6 address associated with the given MAC address.

+
+ - + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
mac @@ -689,162 +1686,148 @@ the corresponding host.

The MAC address to lookup.

 + +

The MAC address to lookup.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getIPAddrByMACAddr(mac) → {null|string}

- - - - -
-

Lookup the IPv4 address associated with the given MAC address.

-
- - - - - - - - - -
Parameters:
+ + +
Returns:
+ - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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 +
+ +
- Description - - + +
+
+ + +
+

Lookup the IPv4 address associated with the given MAC address.

+
+ - + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
mac @@ -853,162 +1836,148 @@ the corresponding host.

The MAC address to lookup.

 + +

The MAC address to lookup.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getMACAddrByIP6Addr(ipaddr) → {null|string}

- - - - -
-

Lookup the MAC address associated with the given IPv6 address.

-
- - - - - - - - - -
Parameters:
+ +
Returns:
+ + - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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 +
+ +
- Description - - + +
+
+ + +
+

Lookup the MAC address associated with the given IPv6 address.

+
+ - + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
ipaddr @@ -1017,162 +1986,148 @@ the corresponding host.

The IPv6 address to lookup.

 + +

The IPv6 address to lookup.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getMACAddrByIPAddr(ipaddr) → {null|string}

- - - - -
-

Lookup the MAC address associated with the given IPv4 address.

-
- - - - - - - - - -
Parameters:
+ + +
Returns:
+ - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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 +
+ +
- Description - - + +
+
+ + +
+

Lookup the MAC address associated with the given IPv4 address.

+
+ - + + + + + + + + + + + + + + + + + + + + + + + - + - - - - + + - - - + + +
NameTypeDescription
ipaddr @@ -1181,167 +2136,151 @@ the corresponding host.

The IPv4 address to lookup.

 + +

The IPv4 address to lookup.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - -
- - - - - - - - - - - - - - - -
Returns:
- - -
-

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.

-
- - - -
-
- Type -
-
- -null -| - -string - - -
+ +
- - - - - - - + -

getMACHints(preferIp6opt) → {Array.<Array.<string>>}

- - - - -
-

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

-
- - - - - - - - - -
Parameters:
+ + +
Returns:
+ - - - + + + + + + + + + + + + +
NameTypeDescription
+ + 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.
- - Attributes - + + + +
- Default + +
+
+

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

+ + +
+ network.js, line 1771 +
+
- Description - - + +
+
+ + +
+

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

+
+ - + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - + + +
NameTypeDefaultDescription
preferIp6 @@ -1350,19 +2289,7 @@ MAC address.

 - - <optional>
- - - - - - 		@@ -1370,135 +2297,125 @@ MAC address.

Whether to prefer IPv6 addresses (true) or IPv4 addresses (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.
- - - - - - + + +
- - + - - - - - - - - - - -
Source:
-
- - - + +
+ + + + + + + + +
Returns:
+ - - - - - - - - - - -
Returns:
- + + + -
-

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 +

+ + + + + + + + + + + +
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 +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.

- - - - -
-
- Type -
-
- -Array.<Array.<string>> - - -
-
- +is used as hint.
- - - - - + + +
+
+ + + +
-
- - + -
- -
-
- Documentation generated by JSDoc 3.6.3 on Tue Nov 05 2019 09:33:05 GMT+0100 (Central European Standard Time) -
+ - - +
+ 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