Date: Mon, 24 Sep 2018 09:29:55 +0100 Subject: Import Upstream version 1.12.2 --- docs/libnm-glib/html/NMDevice.html | 250 ++++++++++++++++++------------------- 1 file changed, 125 insertions(+), 125 deletions(-) (limited to 'docs/libnm-glib/html/NMDevice.html') diff --git a/docs/libnm-glib/html/NMDevice.html b/docs/libnm-glib/html/NMDevice.html index 1f1181b7..a6811017 100644 --- a/docs/libnm-glib/html/NMDevice.html +++ b/docs/libnm-glib/html/NMDevice.html @@ -8,7 +8,7 @@ - + @@ -44,7 +44,7 @@ -GQuark +GQuark nm_device_error_quark () @@ -52,7 +52,7 @@ -GObject * +GObject * nm_device_new () @@ -74,7 +74,7 @@ -NMDeviceType +NMDeviceType nm_device_get_device_type () @@ -124,7 +124,7 @@ -NMDeviceCapabilities +NMDeviceCapabilities nm_device_get_capabilities () @@ -132,7 +132,7 @@ -gboolean +gboolean nm_device_get_managed () @@ -148,7 +148,7 @@ -gboolean +gboolean nm_device_get_autoconnect () @@ -164,7 +164,7 @@ -gboolean +gboolean nm_device_get_firmware_missing () @@ -204,7 +204,7 @@ -NMDeviceState +NMDeviceState nm_device_get_state () @@ -212,7 +212,7 @@ -NMDeviceState +NMDeviceState nm_device_get_state_reason () @@ -227,7 +227,7 @@ -const GPtrArray * +const GPtrArray * nm_device_get_available_connections () @@ -242,7 +242,7 @@ -guint32 +guint32 nm_device_get_mtu () @@ -250,7 +250,7 @@ -gboolean +gboolean nm_device_is_software () @@ -258,7 +258,7 @@ -gboolean +gboolean nm_device_is_real () @@ -319,7 +319,7 @@ -GSList * +GSList * nm_device_filter_connections () @@ -327,7 +327,7 @@ -gboolean +gboolean nm_device_connection_valid () @@ -335,7 +335,7 @@ -gboolean +gboolean nm_device_connection_compatible () @@ -343,7 +343,7 @@ -GType +GType nm_device_get_setting_type () @@ -376,7 +376,7 @@ Read -gboolean +gboolean autoconnect Read / Write @@ -387,12 +387,12 @@ Read -guint +guint capabilities Read -guint +guint device-type Read @@ -410,36 +410,36 @@ -gchar * +gchar * driver Read -gchar * +gchar * driver-version Read -gboolean +gboolean firmware-missing Read -gchar * +gchar * firmware-version Read -gchar * +gchar * interface Read -gchar * +gchar * ip-interface Read @@ -456,34 +456,34 @@ Read -gboolean +gboolean managed Read -guint +guint mtu Read -gchar * +gchar * physical-port-id Read -gchar * +gchar * product Read -gboolean +gboolean real Read -guint +guint state Read @@ -494,13 +494,13 @@ -gchar * +gchar * udi Read -gchar * +gchar * vendor Read @@ -518,7 +518,7 @@ void state-changed -Run First +Run First @@ -639,7 +639,7 @@

Object Hierarchy

    GObject
+    GObject
     ╰── NMObject
         ╰── NMDevice
             ├── NMDeviceEthernet
@@ -664,7 +664,7 @@
 Functions
 
 nm_device_error_quark ()
-GQuark
+GQuark
 nm_device_error_quark (void);
 Registers an error quark for NMDevice if necessary.
 
@@ -676,8 +676,8 @@ nm_device_error_quark (void
 
 nm_device_new ()
-GObject *
-nm_device_new (DBusGConnection *connection,
+GObject *
+nm_device_new (DBusGConnection *connection,
                const char *path);
 Creates a new NMDevice.
 
@@ -691,7 +691,7 @@ nm_device_new (connection
-the DBusGConnection
+the DBusGConnection
  
 
 
@@ -766,7 +766,7 @@ used by the device, and must not be modified.
 
 
 nm_device_get_device_type ()
-NMDeviceType
+NMDeviceType
 nm_device_get_device_type (NMDevice *device);
 Returns the numeric type of the NMDevice, ie Ethernet, Wi-Fi, etc.
 
@@ -952,7 +952,7 @@ nm_device_get_hw_address (
 Returns
- the current MAC of the device, or NULL.
+
 the current MAC of the device, or NULL.
 This is the internal string used by the device, and must not be modified.
 

 Since: 0.9.10
@@ -960,7 +960,7 @@ This is the internal string used by the device, and must not be modified.
 
 
 nm_device_get_capabilities ()
-NMDeviceCapabilities
+NMDeviceCapabilities
 nm_device_get_capabilities (NMDevice *device);
 Gets the device' capabilities.
 
@@ -986,7 +986,7 @@ nm_device_get_capabilities (
 nm_device_get_managed ()
-gboolean
+gboolean
 nm_device_get_managed (NMDevice *device);
 Whether the NMDevice is managed by NetworkManager.
 
@@ -1006,7 +1006,7 @@ nm_device_get_managed (
 Returns
- TRUE if the device is managed by NetworkManager
+ TRUE if the device is managed by NetworkManager
 

 

 
@@ -1014,7 +1014,7 @@ nm_device_get_managed (nm_device_set_managed ()
 void
 nm_device_set_managed (NMDevice *device,
-                       gboolean managed);
+                       gboolean managed);

 Enables or disables management of  NMDevice by NetworkManager.
 
 Parameters
@@ -1032,7 +1032,7 @@ nm_device_set_managed (managed
-TRUE to make the device managed by NetworkManager.
+TRUE to make the device managed by NetworkManager.
  
 
 
@@ -1043,7 +1043,7 @@ nm_device_set_managed (
 nm_device_get_autoconnect ()
-gboolean
+gboolean
 nm_device_get_autoconnect (NMDevice *device);
 Whether the NMDevice can be autoconnected.
 
@@ -1063,7 +1063,7 @@ nm_device_get_autoconnect (
 Returns
- TRUE if the device is allowed to be autoconnected
+ TRUE if the device is allowed to be autoconnected
 

 

 
@@ -1071,7 +1071,7 @@ nm_device_get_autoconnect (nm_device_set_autoconnect ()
 void
 nm_device_set_autoconnect (NMDevice *device,
-                           gboolean autoconnect);
+                           gboolean autoconnect);

 Enables or disables automatic activation of the NMDevice.
 
 Parameters
@@ -1089,7 +1089,7 @@ nm_device_set_autoconnect (autoconnect
-TRUE to enable autoconnecting
+TRUE to enable autoconnecting
  
 
 
@@ -1099,7 +1099,7 @@ nm_device_set_autoconnect (
 nm_device_get_firmware_missing ()
-gboolean
+gboolean
 nm_device_get_firmware_missing (NMDevice *device);
 Indicates that firmware required for the device's operation is likely
 to be missing.
@@ -1120,7 +1120,7 @@ to be missing.
 

 
 Returns
- TRUE if firmware required for the device's operation is likely
+
 TRUE if firmware required for the device's operation is likely
 to be missing.
 
 

@@ -1150,7 +1150,7 @@ connections.
 

 
 Returns
-the NMIP4Config or NULL if the device is not activated. 
+the NMIP4Config or NULL if the device is not activated. 
 [transfer none]
 
 

@@ -1180,7 +1180,7 @@ connections.
 

 
 Returns
-the NMDHCP4Config or NULL if the device is not activated or not
+
the NMDHCP4Config or NULL if the device is not activated or not
 using DHCP. 
 [transfer none]
 
@@ -1211,7 +1211,7 @@ connections.
 

 
 Returns
-the NMIP6Config or NULL if the device is not activated. 
+the NMIP6Config or NULL if the device is not activated. 
 [transfer none]

@@ -1241,7 +1241,7 @@ connections. Returns -the NMDHCP6Config or NULL if the device is not activated or not + the NMDHCP6Config or NULL if the device is not activated or not using DHCP. [transfer none] @@ -1249,7 +1249,7 @@ using DHCP. nm_device_get_state () -NMDeviceState +NMDeviceState nm_device_get_state (NMDevice *device); Gets the current NMDevice state. @@ -1275,9 +1275,9 @@ nm_device_get_state ( nm_device_get_state_reason () -NMDeviceState +NMDeviceState nm_device_get_state_reason (NMDevice *device, - NMDeviceStateReason *reason); + NMDeviceStateReason *reason); Gets the current NMDevice state (return value) and the reason for entering the state (reason argument). @@ -1297,7 +1297,7 @@ the state (reason reason -location to store reason (NMDeviceStateReason), or NULL. +location to store reason (NMDeviceStateReason), or NULL. [out][allow-none] @@ -1331,7 +1331,7 @@ nm_device_get_active_connection ( Returns -the NMActiveConnection or NULL if the device is + the NMActiveConnection or NULL if the device is not part of an active connection. [transfer none] @@ -1339,9 +1339,9 @@ not part of an active connection. nm_device_get_available_connections () -const GPtrArray * +const GPtrArray * nm_device_get_available_connections (NMDevice *device); -Gets the NMRemoteConnections currently known to the daemon that could + Gets the NMRemoteConnections currently known to the daemon that could be activated on device . @@ -1361,8 +1361,8 @@ be activated on device Returns -the GPtrArray -containing NMRemoteConnections. This is the internal copy used by + the GPtrArray +containing NMRemoteConnections. This is the internal copy used by the connection, and must not be modified. [element-type NMRemoteConnection] @@ -1373,9 +1373,9 @@ the connection, and must not be modified. nm_device_get_physical_port_id () const char * nm_device_get_physical_port_id (NMDevice *device); -Gets the physical port ID of the NMDevice. If non-NULL, this is + Gets the physical port ID of the NMDevice. If non-NULL, this is an opaque string that can be used to recognize when -seemingly-unrelated NMDevices are actually just different virtual +seemingly-unrelated NMDevices are actually just different virtual ports on a single physical port. (Eg, NPAR / SR-IOV.) Parameters @@ -1394,7 +1394,7 @@ ports on a single physical port. (Eg, NPAR / SR-IOV.) Returns - the physical port ID of the device, or NULL if the port + the physical port ID of the device, or NULL if the port ID is unknown. This is the internal string used by the device and must not be modified. @@ -1403,7 +1403,7 @@ must not be modified. nm_device_get_mtu () -guint32 +guint32 nm_device_get_mtu (NMDevice *device); Gets the MTU of the NMDevice. @@ -1423,14 +1423,14 @@ nm_device_get_mtu ( Returns - the MTU of the device. + the MTU of the device in bytes. Since: 0.9.10 nm_device_is_software () -gboolean +gboolean nm_device_is_software (NMDevice *device); Whether the device is a software device. @@ -1450,15 +1450,15 @@ nm_device_is_software ( Returns - TRUE if device -is a software device, FALSE if it is a hardware device. + TRUE if device +is a software device, FALSE if it is a hardware device. Since: 1.0 nm_device_is_real () -gboolean +gboolean nm_device_is_real (NMDevice *device); Parameters @@ -1477,7 +1477,7 @@ nm_device_is_real ( Returns - TRUE if the device exists, or FALSE if it is a placeholder device + 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. @@ -1611,8 +1611,8 @@ devices in devices NMDeviceCallbackFn () void (*NMDeviceCallbackFn) (NMDevice *device, - GError *error, - gpointer user_data); + GError *error, + gpointer user_data); @@ -1620,7 +1620,7 @@ devices in devices void nm_device_disconnect (NMDevice *device, NMDeviceCallbackFn callback, - gpointer user_data); + gpointer user_data); Disconnects the device if currently connected, and prevents the device from automatically connecting to networks until the next manual network connection request. @@ -1660,7 +1660,7 @@ operation completes. void nm_device_delete (NMDevice *device, NMDeviceCallbackFn callback, - gpointer user_data); + gpointer user_data); Deletes the software device. Hardware devices can't be deleted. Parameters @@ -1696,9 +1696,9 @@ operation completes. nm_device_filter_connections () -GSList * +GSList * nm_device_filter_connections (NMDevice *device, - const GSList *connections); + const GSList *connections); Filters a given list of connections for a given NMDevice object and return connections which may be activated with the device. For example if device @@ -1725,7 +1725,7 @@ incompatible with the device. To get the full list of connections see connections -a list of NMConnection objects to filter. +a list of NMConnection objects to filter. [element-type NMConnection] @@ -1734,20 +1734,20 @@ incompatible with the device. To get the full list of connections see Returns a -list of NMConnection objects that could be activated with the given device +list of NMConnection objects that could be activated with the given device . The elements of the list are owned by their creator and should not be freed by the caller, but the returned list itself is owned by the caller and should -be freed with g_slist_free() when it is no longer required. +be freed with g_slist_free() when it is no longer required. [transfer container][element-type NMConnection] nm_device_connection_valid () -gboolean +gboolean nm_device_connection_valid (NMDevice *device, - NMConnection *connection); + NMConnection *connection); Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if device @@ -1773,7 +1773,7 @@ against connection -an NMConnection to validate against device + an NMConnection to validate against device @@ -1782,17 +1782,17 @@ against Returns - TRUE if the connection may be activated with this device, FALSE + TRUE if the connection may be activated with this device, FALSE if is incompatible with the device's capabilities and characteristics. nm_device_connection_compatible () -gboolean +gboolean nm_device_connection_compatible (NMDevice *device, - NMConnection *connection, - GError **error); + NMConnection *connection, + GError **error); Validates a given connection for a given NMDevice object and returns whether the connection may be activated with the device. For example if device @@ -1821,13 +1821,13 @@ against connection -an NMConnection to validate against device + an NMConnection to validate against device error -return location for a GError, or NULL +return location for a GError, or NULL @@ -1835,16 +1835,16 @@ against Returns - TRUE if the connection may be activated with this device, FALSE + TRUE if the connection may be activated with this device, FALSE if is incompatible with the device's capabilities and characteristics. nm_device_get_setting_type () -GType +GType nm_device_get_setting_type (NMDevice *device); -Gets the (primary) NMSetting subtype associated with connections + Gets the (primary) NMSetting subtype associated with connections that can be used on device . @@ -1865,7 +1865,7 @@ that can be used on device Returns device -'s associated NMSetting type +'s associated NMSetting type Since: 0.9.10 @@ -1874,8 +1874,8 @@ that can be used on device NMDeviceDeactivateFn () void (*NMDeviceDeactivateFn) (NMDevice *device, - GError *error, - gpointer user_data); + GError *error, + gpointer user_data); NMDeviceDeactivateFn is deprecated and should not be used in newly-written code. @@ -2073,7 +2073,7 @@ that can be used on device The “autoconnect” property - “autoconnect” gboolean + “autoconnect” gboolean Whether the device can auto-activate a connection. Flags: Read / Write Default value: TRUE @@ -2089,7 +2089,7 @@ that can be used on device The “capabilities” property - “capabilities” guint + “capabilities” guint The capabilities of the device. Flags: Read Default value: 0 @@ -2097,7 +2097,7 @@ that can be used on device The “device-type” property - “device-type” guint + “device-type” guint The numeric type of the device. Flags: Read Default value: 0 @@ -2119,7 +2119,7 @@ that can be used on device The “driver” property - “driver” gchar * + “driver” gchar * The driver of the device. Flags: Read Default value: NULL @@ -2127,7 +2127,7 @@ that can be used on device The “driver-version” property - “driver-version” gchar * + “driver-version” gchar * The version of the device driver. Flags: Read Default value: NULL @@ -2135,8 +2135,8 @@ that can be used on device The “firmware-missing” property - “firmware-missing” gboolean -When TRUE indicates the device is likely missing firmware required + “firmware-missing” gboolean +When TRUE indicates the device is likely missing firmware required for its operation. Flags: Read Default value: FALSE @@ -2144,7 +2144,7 @@ for its operation. The “firmware-version” property - “firmware-version” gchar * + “firmware-version” gchar * The firmware version of the device. Flags: Read Default value: NULL @@ -2152,7 +2152,7 @@ for its operation. The “interface” property - “interface” gchar * + “interface” gchar * The interface of the device. Flags: Read Default value: NULL @@ -2160,7 +2160,7 @@ for its operation. The “ip-interface” property - “ip-interface” gchar * + “ip-interface” gchar * The IP interface of the device which should be used for all IP-related operations like addressing and routing. Flags: Read @@ -2183,7 +2183,7 @@ operations like addressing and routing. The “managed” property - “managed” gboolean + “managed” gboolean Whether the device is managed by NetworkManager. Flags: Read Default value: FALSE @@ -2191,7 +2191,7 @@ operations like addressing and routing. The “mtu” property - “mtu” guint + “mtu” guint The MTU of the device. Flags: Read Default value: 1500 @@ -2200,7 +2200,7 @@ operations like addressing and routing. The “physical-port-id” property - “physical-port-id” gchar * + “physical-port-id” gchar * The physical port ID of the device. (See nm_device_get_physical_port_id().) Flags: Read @@ -2210,7 +2210,7 @@ operations like addressing and routing. The “product” property - “product” gchar * + “product” gchar * The product string of the device. Flags: Read Default value: NULL @@ -2218,7 +2218,7 @@ operations like addressing and routing. The “real” property - “real” gboolean + “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. @@ -2229,7 +2229,7 @@ be created automatically by NetworkManager if one of its The “state” property - “state” guint + “state” guint The state of the device. Flags: Read Default value: 0 @@ -2244,7 +2244,7 @@ be created automatically by NetworkManager if one of its The “udi” property - “udi” gchar * + “udi” gchar * 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) @@ -2257,7 +2257,7 @@ request more information about the device from those services. The “vendor” property - “vendor” gchar * + “vendor” gchar * The vendor string of the device. Flags: Read Default value: NULL @@ -2269,10 +2269,10 @@ request more information about the device from those services. The “state-changed” signal void user_function (NMDevice *device, - guint new_state, - guint old_state, - guint reason, - gpointer user_data) + guint new_state, + guint old_state, + guint reason, + gpointer user_data) Notifies the state change of a NMDevice. Parameters @@ -2311,11 +2311,11 @@ user_function ( -Flags: Run First +Flags: Run First - Generated by GTK-Doc V1.27 + Generated by GTK-Doc V1.28 \ No newline at end of file -- cgit 1.3.0-6-gf8a5