From 494f296a3baab08522617b24b1f126d8f9a17502 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 20 Jan 2016 16:26:51 +0100 Subject: Imported Upstream version 1.1.90 --- docs/libnm-glib/html/NMClient.html | 280 +++++++++++++++++++++++++++++-------- 1 file changed, 218 insertions(+), 62 deletions(-) (limited to 'docs/libnm-glib/html/NMClient.html') diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html index 1f0d4ae2..865c607a 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -82,6 +82,13 @@ +const GPtrArray * + + +nm_client_get_all_devices () + + + NMDevice * @@ -368,6 +375,12 @@ Read + +NMObjectArray * +all-devices +Read + + guint connectivity Read @@ -454,6 +467,16 @@ void +any-device-added +Run First + + +void +any-device-removed +Run First + + +void device-added Run First @@ -543,6 +566,10 @@ NM_CLIENT_DEVICES +#define +NM_CLIENT_ALL_DEVICES + + enum NMClientPermission @@ -713,13 +740,50 @@ containing all the NMDevices
+

nm_client_get_all_devices ()

+
const GPtrArray *
+nm_client_get_all_devices (NMClient *client);
+

Gets both real devices and device placeholders (eg, software devices which +do not currently exist, but could be created automatically by NetworkManager +if one of their NMDevice::ActivatableConnections was activated). Use +nm_device_is_real() to determine whether each device is a real device or +a placeholder.

+

Use nm_device_get_type() or the NM_IS_DEVICE_XXXX() functions to determine +what kind of device each member of the returned array is, and then you may +use device-specific methods such as nm_device_ethernet_get_hw_address().

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

a GPtrArray +containing all the NMDevices. The returned array is owned by the +NMClient object and should not be modified.

+

[transfer none][element-type NMDevice]

+
+

Since: 1.2

+
+
+

nm_client_get_device_by_path ()

NMDevice *
 nm_client_get_device_by_path (NMClient *client,
                               const char *object_path);

Gets a NMDevice from a NMClient.

-

Parameters

+

Parameters

@@ -741,7 +805,7 @@ nm_client_get_device_by_path ( -

Returns

+

Returns

the NMDevice for the given object_path or NULL if none is found.

[transfer none]

@@ -755,7 +819,7 @@ nm_client_get_device_by_iface (const char *iface);

Gets a NMDevice from a NMClient.

-

Parameters

+

Parameters

@@ -777,7 +841,7 @@ nm_client_get_device_by_iface (
-

Returns

+

Returns

the NMDevice for the given iface or NULL if none is found.

[transfer none]

@@ -820,7 +884,7 @@ the new connection, not when it finishes. You can used the returned NMActiveConnection object (in particular, “state”) to track the activation to its completion.

-

Parameters

+

Parameters

@@ -898,7 +962,7 @@ the new connection, not when it finishes. You can used the returned NMActiveConnection object (in particular, “state”) to track the activation to its completion.

-

Parameters

+

Parameters

@@ -959,7 +1023,7 @@ nm_client_deactivate_connection (NMActiveConnection *active);

Deactivates an active NMActiveConnection.

-

Parameters

+

Parameters

@@ -988,7 +1052,7 @@ nm_client_deactivate_connection (NMClient *client);

Whether networking is enabled or disabled.

-

Parameters

+

Parameters

@@ -1003,7 +1067,7 @@ nm_client_networking_get_enabled (
-

Returns

+

Returns

TRUE if networking is enabled, FALSE if networking is disabled

@@ -1017,7 +1081,7 @@ nm_client_networking_set_enabled (
-

Parameters

+

Parameters

@@ -1046,7 +1110,7 @@ all controlled interfaces are available for activation.

nm_client_wireless_get_enabled (NMClient *client);

Determines whether the wireless is enabled.

-

Parameters

+

Parameters

@@ -1061,7 +1125,7 @@ nm_client_wireless_get_enabled (
-

Returns

+

Returns

TRUE if wireless is enabled

@@ -1073,7 +1137,7 @@ nm_client_wireless_set_enabled (gboolean enabled);

Enables or disables wireless devices.

-

Parameters

+

Parameters

@@ -1103,7 +1167,7 @@ nm_client_wireless_hardware_get_enabled (NMClient *client);

Determines whether the wireless hardware is enabled.

-

Parameters

+

Parameters

@@ -1118,7 +1182,7 @@ nm_client_wireless_hardware_get_enabled
-

Returns

+

Returns

TRUE if the wireless hardware is enabled

@@ -1129,7 +1193,7 @@ nm_client_wireless_hardware_get_enabled nm_client_wwan_get_enabled (NMClient *client);

Determines whether WWAN is enabled.

-

Parameters

+

Parameters

@@ -1144,7 +1208,7 @@ nm_client_wwan_get_enabled ( -

Returns

+

Returns

TRUE if WWAN is enabled

@@ -1156,7 +1220,7 @@ nm_client_wwan_set_enabled (gboolean enabled);

Enables or disables WWAN devices.

-

Parameters

+

Parameters

@@ -1185,7 +1249,7 @@ nm_client_wwan_set_enabled (NMClient *client);

Determines whether the WWAN hardware is enabled.

-

Parameters

+

Parameters

@@ -1200,7 +1264,7 @@ nm_client_wwan_hardware_get_enabled (
-

Returns

+

Returns

TRUE if the WWAN hardware is enabled

@@ -1211,7 +1275,7 @@ nm_client_wwan_hardware_get_enabled (NMClient *client);

Determines whether WiMAX is enabled.

-

Parameters

+

Parameters

@@ -1226,7 +1290,7 @@ nm_client_wimax_get_enabled ( -

Returns

+

Returns

TRUE if WiMAX is enabled

@@ -1238,7 +1302,7 @@ nm_client_wimax_set_enabled (gboolean enabled);

Enables or disables WiMAX devices.

-

Parameters

+

Parameters

@@ -1267,7 +1331,7 @@ nm_client_wimax_set_enabled (NMClient *client);

Determines whether the WiMAX hardware is enabled.

-

Parameters

+

Parameters

@@ -1282,7 +1346,7 @@ nm_client_wimax_hardware_get_enabled ( -

Returns

+

Returns

TRUE if the WiMAX hardware is enabled

@@ -1293,7 +1357,7 @@ nm_client_wimax_hardware_get_enabled (NMClient *client);

Gets NetworkManager version.

-

Parameters

+

Parameters

@@ -1308,7 +1372,7 @@ nm_client_get_version ( -

Returns

+

Returns

string with the version

@@ -1319,7 +1383,7 @@ nm_client_get_version (NMClient *client);

Gets the current daemon state.

-

Parameters

+

Parameters

@@ -1334,7 +1398,7 @@ nm_client_get_state ( -

Returns

+

Returns

the current NMState

@@ -1346,7 +1410,7 @@ nm_client_get_startup ( -

Parameters

+

Parameters

@@ -1361,7 +1425,7 @@ connections at startup.

-

Returns

+

Returns

whether the daemon is still starting up

Since: 0.9.10

@@ -1373,7 +1437,7 @@ connections at startup.

nm_client_get_manager_running (NMClient *client);

Determines whether the daemon is running.

-

Parameters

+

Parameters

@@ -1388,7 +1452,7 @@ nm_client_get_manager_running (
-

Returns

+

Returns

TRUE if the daemon is running

@@ -1399,7 +1463,7 @@ nm_client_get_manager_running (NMClient *client);

Gets the active connections.

-

Parameters

+

Parameters

@@ -1414,7 +1478,7 @@ nm_client_get_active_connections (
-

Returns

+

Returns

a GPtrArray containing all the active NMActiveConnections. The returned array is owned by the client and should not be modified.

@@ -1429,7 +1493,7 @@ nm_client_sleep (gboolean sleep_);

Deprecated; use nm_client_networking_set_enabled() instead.

-

Parameters

+

Parameters

@@ -1460,7 +1524,7 @@ nm_client_get_permission_result (Requests the result of a specific permission, which indicates whether the client can or cannot perform the action the permission represents

-

Parameters

+

Parameters

@@ -1482,7 +1546,7 @@ client can or cannot perform the action the permission represents

-

Returns

+

Returns

the permission's result, one of NMClientPermissionResult

@@ -1496,7 +1560,7 @@ nm_client_get_logging (GError **error);

Gets NetworkManager current logging level and domains.

-

Parameters

+

Parameters

@@ -1529,7 +1593,7 @@ a list of domains separated by ",".

-

Returns

+

Returns

TRUE on success, FALSE otherwise

Since: 0.9.8

@@ -1544,7 +1608,7 @@ nm_client_set_logging (GError **error);

Sets NetworkManager logging level and/or domains.

-

Parameters

+

Parameters

@@ -1577,7 +1641,7 @@ domains separated by ",". (NULL or an empty string
-

Returns

+

Returns

TRUE on success, FALSE otherwise

Since: 0.9.8

@@ -1592,7 +1656,7 @@ nm_client_get_connectivity (nm_client_check_connectivity_async(), which re-check the connectivity state first before returning any information.

-

Parameters

+

Parameters

@@ -1607,7 +1671,7 @@ connectivity state first before returning any information.

-

Returns

+

Returns

the current connectivity state

Since: 0.9.8.6

@@ -1625,7 +1689,7 @@ the most recent known state without re-checking.

This is a blocking call; use nm_client_check_connectivity_async() if you do not want to block.

-

Parameters

+

Parameters

@@ -1652,7 +1716,7 @@ if you do not want to block.

-

Returns

+

Returns

the (new) current connectivity state

Since: 0.9.8.6

@@ -1671,7 +1735,7 @@ nm_client_check_connectivity_async (nm_client_check_connectivity(), which blocks.

-

Parameters

+

Parameters

@@ -1715,7 +1779,7 @@ nm_client_check_connectivity_finish (Retrieves the result of an nm_client_check_connectivity_async() call.

-

Parameters

+

Parameters

@@ -1742,7 +1806,7 @@ call.

-

Returns

+

Returns

the (new) current connectivity state

Since: 0.9.8.6

@@ -1762,7 +1826,7 @@ route to the VPN endpoint.

If there is no default route, or the default route is over a non-NetworkManager-recognized device, this will return NULL.

-

Parameters

+

Parameters

@@ -1777,7 +1841,7 @@ non-NetworkManager-recognized device, this will return NUL
-

Returns

+

Returns

the appropriate NMActiveConnection, if any.

[transfer none]

@@ -1793,7 +1857,7 @@ nm_client_get_activating_connection (“primary-connection” upon successful activation.

-

Parameters

+

Parameters

@@ -1808,7 +1872,7 @@ currently-activating connection that is expected to become the new
-

Returns

+

Returns

the appropriate NMActiveConnection, if any.

[transfer none]

@@ -1915,11 +1979,17 @@ any.

+

NM_CLIENT_ALL_DEVICES

+
#define NM_CLIENT_ALL_DEVICES "all-devices"
+
+
+
+

enum NMClientPermission

NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

-

Members

+

Members

@@ -2039,7 +2109,7 @@ clients can obtain to perform certain tasks on behalf of the current user.

NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission

-

Members

+

Members

@@ -2086,7 +2156,7 @@ the user requires to obtain a given

enum NMClientError

Describes errors that may result from operations involving a NMClient.

-

Members

+

Members

@@ -2140,6 +2210,14 @@ Type: GLib.PtrArray

+

The “all-devices” property

+
  “all-devices”              NMObjectArray *
+

List of both real devices and device placeholders.

+

Flags: Read

+

Since: 1.2

+
+
+

The “connectivity” property

  “connectivity”             guint

The network connectivity state.

@@ -2152,7 +2230,7 @@ Type: GLib.PtrArray

The “devices” property

  “devices”                  NMObjectArray *
-

List of known network devices.

+

List of real network devices. Does not include placeholder devices.

Flags: Read

Since: 0.9.10

@@ -2259,12 +2337,13 @@ see

Signal Details

-

The “device-added” signal

+

The “any-device-added” signal

void
 user_function (NMClient *client,
                GObject  *device,
                gpointer  user_data)
-

Notifies that a NMDevice is added.

+

Notifies that a NMDevice is added. This signal is emitted for both +regular devices and placeholder devices.

Parameters

@@ -2296,12 +2375,13 @@ user_function (
-

The “device-removed” signal

+

The “any-device-removed” signal

void
 user_function (NMClient *client,
                GObject  *device,
                gpointer  user_data)
-

Notifies that a NMDevice is removed.

+

Notifies that a NMDevice is removed. This signal is emitted for both +regular devices and placeholder devices.

Parameters

@@ -2333,6 +2413,82 @@ user_function (
+

The “device-added” signal

+
void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)
+

Notifies that a NMDevice is added. This signal is not emitted for +placeholder devices.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

client

the client that received the signal

 

device

the new device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+
+
+
+

The “device-removed” signal

+
void
+user_function (NMClient *client,
+               GObject  *device,
+               gpointer  user_data)
+

Notifies that a NMDevice is removed. This signal is not emitted for +placeholder devices.

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

client

the client that received the signal

 

device

the removed device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
+
+

Flags: Run First

+
+
+

The “permission-changed” signal

void
 user_function (NMClient *client,
@@ -2341,7 +2497,7 @@ user_function (gpointer  user_data)

Notifies that a permission has changed

-

Parameters

+

Parameters

-- cgit 1.3.0-6-gf8a5