From 0018d1f3cf71d680d7b6bceda55a5717244d8b26 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 16 Aug 2022 18:24:19 +0200 Subject: New upstream version 1.39.90 --- docs/libnm/html/NMDevice.html | 628 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 624 insertions(+), 4 deletions(-) (limited to 'docs/libnm/html/NMDevice.html') diff --git a/docs/libnm/html/NMDevice.html b/docs/libnm/html/NMDevice.html index c12e7f5c..ac125f88 100644 --- a/docs/libnm/html/NMDevice.html +++ b/docs/libnm/html/NMDevice.html @@ -16,7 +16,9 @@ Top  |  Description  |  - Object Hierarchy + Object Hierarchy  |  + Properties  |  + Signals Home Up @@ -523,6 +525,217 @@ +
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMActiveConnection *active-connectionRead
gbooleanautoconnectRead / Write
+GPtrArray *available-connectionsRead
NMDeviceCapabilitiescapabilitiesRead
NMDeviceTypedevice-typeRead
+NMDhcpConfig *dhcp4-configRead
+NMDhcpConfig *dhcp6-configRead
+char *driverRead
+char *driver-versionRead
gbooleanfirmware-missingRead
+char *firmware-versionRead
+char *hw-addressRead
+char *interfaceRead
guintinterface-flagsRead
+char *ip-interfaceRead
+NMIPConfig *ip4-configRead
NMConnectivityStateip4-connectivityRead
+NMIPConfig *ip6-configRead
NMConnectivityStateip6-connectivityRead
+GPtrArray *lldp-neighborsRead
gbooleanmanagedRead
guintmeteredRead
guintmtuRead
gbooleannm-plugin-missingRead
+char *pathRead
+char *physical-port-idRead
+GPtrArray *portsRead
+char *productRead
gbooleanrealRead
NMDeviceStatestateRead
guintstate-reasonRead
+char *udiRead
+char *vendorRead
+
+
+

Signals

+
+++++ + + + + + +
voidstate-changedRun First
+

Types and Values

@@ -665,6 +878,10 @@ + + + + @@ -674,6 +891,37 @@

Object Hierarchy

    GBoxed
     ╰── NMLldpNeighbor
+    GObject
+    ╰── NMObject
+        ╰── NMDevice
+            ├── NMDevice6Lowpan
+            ├── NMDeviceAdsl
+            ├── NMDeviceBond
+            ├── NMDeviceBridge
+            ├── NMDeviceBt
+            ├── NMDeviceDummy
+            ├── NMDeviceEthernet
+            ├── NMDeviceGeneric
+            ├── NMDeviceInfiniband
+            ├── NMDeviceIPTunnel
+            ├── NMDeviceMacsec
+            ├── NMDeviceMacvlan
+            ├── NMDeviceModem
+            ├── NMDeviceOlpcMesh
+            ├── NMDeviceOvsBridge
+            ├── NMDeviceOvsInterface
+            ├── NMDeviceOvsPort
+            ├── NMDevicePpp
+            ├── NMDeviceTeam
+            ├── NMDeviceTun
+            ├── NMDeviceVlan
+            ├── NMDeviceVrf
+            ├── NMDeviceVxlan
+            ├── NMDeviceWifi
+            ├── NMDeviceWifiP2P
+            ├── NMDeviceWimax
+            ├── NMDeviceWireGuard
+            ╰── NMDeviceWpan
@@ -1546,7 +1794,7 @@ nm_device_is_real (

Returns

TRUE if the device exists, or FALSE if it is a placeholder device that could be automatically created by NetworkManager if one of its -“available-connections” was activated.

+“available-connections” was activated.

Since: 1.2

@@ -2425,7 +2673,7 @@ incompatible with the device. To get the full list of connections see - + @@ -2434,7 +2682,7 @@ incompatible with the device. To get the full list of connections see

Returns

an array of -NMConnections that could be activated with the given device +NMConnections that could be activated with the given device . The array should be freed with g_ptr_array_unref() when it is no longer required.

WARNING: the transfer annotation for this function may not work correctly @@ -3034,6 +3282,11 @@ nm_lldp_neighbor_get_attr_type (

+

NMDevice

+
typedef struct _NMDevice NMDevice;
+
+
+

NMLldpNeighbor

typedef struct _NMLldpNeighbor NMLldpNeighbor;

Supported attributes are:

@@ -3110,6 +3363,373 @@ all the VLANs.

+
+

Property Details

+
+

The “active-connection” property

+
  “active-connection”        NMActiveConnection *
+

The NMActiveConnection object that "owns" this device during activation.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “autoconnect” property

+
  “autoconnect”              gboolean
+

Whether the device can auto-activate a connection.

+

The property setter is a synchronous D-Bus call. This is deprecated since 1.22.

+

Owner: NMDevice

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “available-connections” property

+
  “available-connections”    GPtrArray *
+

The available connections of the device

+

[type GPtrArray(NMRemoteConnection)]

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “capabilities” property

+
  “capabilities”             NMDeviceCapabilities
+

The capabilities of the device.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “device-type” property

+
  “device-type”              NMDeviceType
+

The numeric type of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NM_DEVICE_TYPE_UNKNOWN

+
+
+
+

The “dhcp4-config” property

+
  “dhcp4-config”             NMDhcpConfig *
+

The IPv4 NMDhcpConfig of the device.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “dhcp6-config” property

+
  “dhcp6-config”             NMDhcpConfig *
+

The IPv6 NMDhcpConfig of the device.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “driver” property

+
  “driver”                   char *
+

The driver of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “driver-version” property

+
  “driver-version”           char *
+

The version of the device driver.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “firmware-missing” property

+
  “firmware-missing”         gboolean
+

When TRUE indicates the device is likely missing firmware required +for its operation.

+

Owner: NMDevice

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “firmware-version” property

+
  “firmware-version”         char *
+

The firmware version of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “hw-address” property

+
  “hw-address”               char *
+

The hardware address of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+

Since: 1.24

+
+
+
+

The “interface” property

+
  “interface”                char *
+

The interface of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “interface-flags” property

+
  “interface-flags”          guint
+

The interface flags.

+

Owner: NMDevice

+

Flags: Read

+

Default value: 0

+

Since: 1.22

+
+
+
+

The “ip-interface” property

+
  “ip-interface”             char *
+

The IP interface of the device which should be used for all IP-related +operations like addressing and routing.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “ip4-config” property

+
  “ip4-config”               NMIPConfig *
+

The NMIP4Config of the device.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “ip4-connectivity” property

+
  “ip4-connectivity”         NMConnectivityState
+

The IPv4 connectivity state of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NM_CONNECTIVITY_UNKNOWN

+

Since: 1.16

+
+
+
+

The “ip6-config” property

+
  “ip6-config”               NMIPConfig *
+

The IPv6 NMIPConfig of the device.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “ip6-connectivity” property

+
  “ip6-connectivity”         NMConnectivityState
+

The IPv6 connectivity state of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NM_CONNECTIVITY_UNKNOWN

+

Since: 1.16

+
+
+
+

The “lldp-neighbors” property

+
  “lldp-neighbors”           GPtrArray *
+

The LLDP neighbors.

+

Owner: NMDevice

+

Flags: Read

+
+
+
+

The “managed” property

+
  “managed”                  gboolean
+

Whether the device is managed by NetworkManager.

+

Owner: NMDevice

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “metered” property

+
  “metered”                  guint
+

Whether the device is metered.

+

Owner: NMDevice

+

Flags: Read

+

Default value: 0

+

Since: 1.2

+
+
+
+

The “mtu” property

+
  “mtu”                      guint
+

The MTU of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: 0

+
+
+
+

The “nm-plugin-missing” property

+
  “nm-plugin-missing”        gboolean
+

When TRUE indicates that the NetworkManager plugin for the device +is not installed.

+

Owner: NMDevice

+

Flags: Read

+

Default value: FALSE

+

Since: 1.2

+
+
+
+

The “path” property

+
  “path”                     char *
+

The device path as exposed by the udev property ID_PATH.

+

The string is backslash escaped (C escaping) for invalid +characters. The escaping can be reverted with g_strcompress(), +however the result may not be valid UTF-8.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+

Since: 1.26

+
+
+
+

The “physical-port-id” property

+
  “physical-port-id”         char *
+

The physical port ID of the device. (See +nm_device_get_physical_port_id().)

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “ports” property

+
  “ports”                    GPtrArray *
+

The port devices of the controller device. For devices that cannot be +controllers this is likely to be always empty.

+

Owner: NMDevice

+

Flags: Read

+

Since: 1.34

+
+
+
+

The “product” property

+
  “product”                  char *
+

The product string of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “real” property

+
  “real”                     gboolean
+

Whether the device is real or is a placeholder device that could +be created automatically by NetworkManager if one of its +“available-connections” was activated.

+

Owner: NMDevice

+

Flags: Read

+

Default value: FALSE

+

Since: 1.2

+
+
+
+

The “state” property

+
  “state”                    NMDeviceState
+

The state of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NM_DEVICE_STATE_UNKNOWN

+
+
+
+

The “state-reason” property

+
  “state-reason”             guint
+

The reason for the device state.

+

Owner: NMDevice

+

Flags: Read

+

Default value: 0

+
+
+
+

The “udi” property

+
  “udi”                      char *
+

An operating-system specific device hardware identifier; this is not +unique to a specific hardware device across reboots or hotplugs. It +is an opaque string which for some device types (Bluetooth, Modem) +contains an identifier provided by the underlying hardware service daemon +such as Bluez or ModemManager, and clients can use this property to +request more information about the device from those services.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “vendor” property

+
  “vendor”                   char *
+

The vendor string of the device.

+

Owner: NMDevice

+

Flags: Read

+

Default value: NULL

+
+
+
+

Signal Details

+
+

The “state-changed” signal

+
void
+user_function (NMDevice *device,
+               guint     new_state,
+               guint     old_state,
+               guint     reason,
+               gpointer  user_data)
+

Notifies the state change of a NMDevice.

+
+

Parameters

+
 NMDevice
  NMLldpNeighbor

connections

an array of NMConnections to filter.

an array of NMConnections to filter.

[element-type NMConnection]
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

device

the device object that received the signal

 

new_state

the new state of the device

 

old_state

the previous state of the device

 

reason

the reason describing the state change

 

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+ +
Generated by GTK-Doc V1.33.1
-- cgit 1.3.0-6-gf8a5