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.Device.html | 3440 -------------------------- 1 file changed, 3440 deletions(-) delete mode 100644 documentation/jsapi/LuCI.Network.Device.html (limited to 'documentation/jsapi/LuCI.Network.Device.html') diff --git a/documentation/jsapi/LuCI.Network.Device.html b/documentation/jsapi/LuCI.Network.Device.html deleted file mode 100644 index 71d88df22f..0000000000 --- a/documentation/jsapi/LuCI.Network.Device.html +++ /dev/null @@ -1,3440 +0,0 @@ - - - - - Class: Device - - - - - - - - - - - - - - - - - -
- -
-

- -
- -
- -
-
-

Class: Device

- - - - -
- -
-

- LuCI.Network. - - Device -

- -

A Network.Device class instance represents an underlying Linux network -device and allows querying device details such as packet statistics or MTU.

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

- - new LuCI.Network.Device() -

- - -
- network.js, line 2593 -
- -
- - -
-
- - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - -
- - -
- - - - - - - - - - - - - - -

Methods

- -
- -
-
-

- - getBridgeID(){null|string} -

- - -
- network.js, line 2800 -
- -
- - -
-
- - -
-

Get the bridge ID

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the ID of this network bridge or null if this network -device is not a Linux bridge.
- - - - -
- - - -
-
-

- - getBridgeSTP(){boolean} -

- - -
- network.js, line 2812 -
- -
- - -
-
- - -
-

Get the bridge STP setting

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true when this device is a Linux bridge and has stp -enabled, else false.
- - - - -
- - - -
-
-

- - getI18n(){string} -

- - -
- network.js, line 2727 -
- -
- - -
-
- - -
-

Get a long description string for the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns a string containing the type description and device name -for non-wifi devices or operation mode and ssid for wifi ones.
- - - - -
- - - -
-
-

- - getIP6Addrs(){Array.<string>} -

- - -
- network.js, line 2671 -
- -
- - -
-
- - -
-

Get the IPv6 addresses configured on the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Array.<string> - - - Returns an array of IPv6 address strings.
- - - - -
- - - -
-
-

- - getIPAddrs(){Array.<string>} -

- - -
- network.js, line 2660 -
- -
- - -
-
- - -
-

Get the IPv4 addresses configured on the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Array.<string> - - - Returns an array of IPv4 address strings.
- - - - -
- - - -
-
-

- - getMAC(){null|string} -

- - -
- network.js, line 2639 -
- -
- - -
-
- - -
-

Get the MAC address of the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - string - - - Returns the MAC address of the device or null if not applicable, -e.g. for non-ethernet tunnel devices.
- - - - -
- - - -
-
-

- - getMTU(){number} -

- - -
- network.js, line 2650 -
- -
- - -
-
- - -
-

Get the MTU of the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - number - - - Returns the MTU of the device.
- - - - -
- - - -
-
-

- - getName(){string} -

- - -
- network.js, line 2628 -
- -
- - -
-
- - -
-

Get the name of the network device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the name of the device, e.g. eth0 or wlan0.
- - - - -
- - - -
-
-

- - getNetwork(){null|LuCI.Network.Protocol} -

- - -
- network.js, line 2907 -
- -
- - -
-
- - -
-

Get the primary logical interface this device is assigned to.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - LuCI.Network.Protocol - - - Returns a Network.Protocol instance representing the logical -interface this device is attached to or null if it is not -assigned to any logical interface.
- - - - -
- - - -
-
-

- - getNetworks(){Array.<LuCI.Network.Protocol>} -

- - -
- network.js, line 2918 -
- -
- - -
-
- - -
-

Get the logical interfaces this device is assigned to.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - Array.<LuCI.Network.Protocol> - - - Returns an array of Network.Protocol instances representing the -logical interfaces this device is assigned to.
- - - - -
- - - -
-
-

- - getPorts(){null|Array.<LuCI.Network.Device>} -

- - -
- network.js, line 2778 -
- -
- - -
-
- - -
-

Get the associated bridge ports of the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - Array.<LuCI.Network.Device> - - - Returns an array of Network.Device instances representing the ports -(slave interfaces) of the bridge or null when this device isn't -a Linux bridge.
- - - - -
- - - -
-
-

- - getRXBytes(){number} -

- - -
- network.js, line 2872 -
- -
- - -
-
- - -
-

Get the amount of received bytes.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - number - - - Returns the amount of bytes received by the network device.
- - - - -
- - - -
-
-

- - getRXPackets(){number} -

- - -
- network.js, line 2894 -
- -
- - -
-
- - -
-

Get the amount of received packets.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - number - - - Returns the amount of packets received by the network device.
- - - - -
- - - -
-
-

- - getShortName(){string} -

- - -
- network.js, line 2713 -
- -
- - -
-
- - -
-

Get a short description string for the device.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns the device name for non-wifi devices or a string containing -the operation mode and SSID for wifi devices.
- - - - -
- - - -
-
-

- - getTXBytes(){number} -

- - -
- network.js, line 2861 -
- -
- - -
-
- - -
-

Get the amount of transmitted bytes.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - number - - - Returns the amount of bytes transmitted by the network device.
- - - - -
- - - -
-
-

- - getTXPackets(){number} -

- - -
- network.js, line 2883 -
- -
- - -
-
- - -
-

Get the amount of transmitted packets.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - number - - - Returns the amount of packets transmitted by the network device.
- - - - -
- - - -
-
-

- - getType(){string} -

- - -
- network.js, line 2689 -
- -
- - -
-
- - -
-

Get the type of the device..

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns a string describing the type of the network device: -
    -
  • alias if it is an abstract alias device (@ notation)
    • -
  • wifi if it is a wireless interface (e.g. wlan0)
    • -
  • bridge if it is a bridge device (e.g. br-lan)
    • -
  • tunnel if it is a tun or tap device (e.g. tun0)
    • -
  • vlan if it is a vlan device (e.g. eth0.1)
    • -
  • switch if it is a switch device (e.g.eth1 connected to switch0)
    • -
  • ethernet for all other device types
    • -
- - - - -
- - - -
-
-

- - getTypeI18n(){string} -

- - -
- network.js, line 2745 -
- -
- - -
-
- - -
-

Get a string describing the device type.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - string - - - Returns a string describing the type, e.g. "Wireless Adapter" or -"Bridge".
- - - - -
- - - -
-
-

- - getWifiNetwork(){null|LuCI.Network.WifiNetwork} -

- - -
- network.js, line 2942 -
- -
- - -
-
- - -
-

Get the related wireless network this device is related to.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - null - | - - LuCI.Network.WifiNetwork - - - Returns a Network.WifiNetwork instance representing the wireless -network corresponding to this network device or null if this device -is not a wireless device.
- - - - -
- - - -
-
-

- - isBridge(){boolean} -

- - -
- network.js, line 2840 -
- -
- - -
-
- - -
-

Checks whether this device is a Linux bridge.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true when the network device is present and a Linux bridge, -else false.
- - - - -
- - - -
-
-

- - isBridgePort(){boolean} -

- - -
- network.js, line 2851 -
- -
- - -
-
- - -
-

Checks whether this device is part of a Linux bridge.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true when this network device is part of a bridge, -else false.
- - - - -
- - - -
-
-

- - isUp(){boolean} -

- - -
- network.js, line 2824 -
- -
- - -
-
- - -
-

Checks whether this device is up.

-
- - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - -
Returns:
- - - - - - - - - - - - - - - - - - - - -
TypeDescription
- - boolean - - - Returns true when the associated device is running pr false -when it is down or absent.
- - - - -
- -
- - - - - - - -
- -
- - - - - - - -
- 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