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/html/NMClient.html | 287 ++++++++++++++++++++++++++++++++++-------- 1 file changed, 232 insertions(+), 55 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index f5ad56c0..abff5431 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -281,6 +281,13 @@ +const GPtrArray * + + +nm_client_get_all_devices () + + + NMDevice * @@ -495,6 +502,12 @@ Read + +GPtrArray * +all-devices +Read + + gboolean can-modify Read @@ -603,6 +616,16 @@ void +any-device-added +Run First + + +void +any-device-removed +Run First + + +void connection-added Run First @@ -703,6 +726,10 @@ #define +NM_CLIENT_ALL_DEVICES + + +#define NM_CLIENT_CONNECTIONS @@ -727,6 +754,14 @@ #define +NM_CLIENT_ANY_DEVICE_ADDED + + +#define +NM_CLIENT_ANY_DEVICE_REMOVED + + +#define NM_CLIENT_PERMISSION_CHANGED @@ -758,7 +793,7 @@

Object Hierarchy

-
    GEnum
+
    GEnum
     ├── NMClientError
     ├── NMClientPermission
     ╰── NMClientPermissionResult
@@ -1776,13 +1811,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

 
@@ -1804,7 +1876,7 @@ nm_client_get_device_by_path (
-
Returns

+
Returns

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

 
[transfer none]

@@ -1818,7 +1890,7 @@ nm_client_get_device_by_iface (const char *iface);
 
Gets a NMDevice from a NMClient.

 

-
Parameters

+
Parameters

 

 
 

@@ -1840,7 +1912,7 @@ nm_client_get_device_by_iface (
 
 

-
Returns

+
Returns

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

 
[transfer none]

@@ -1853,7 +1925,7 @@ or NULL if none is found. 

 nm_client_get_active_connections (NMClient *client);
 
Gets the active connections.

 

-
Parameters

+
Parameters

 

 
 

@@ -1868,7 +1940,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. 

@@ -1890,7 +1962,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

 

 
 

@@ -1905,7 +1977,7 @@ non-NetworkManager-recognized device, this will return NUL
 

 
 


 

 

-
Returns

+
Returns

 
 the appropriate NMActiveConnection, if
 any. 

 
[transfer none]

@@ -1920,7 +1992,7 @@ nm_client_get_activating_connection (“primary-connection” upon successful activation.

 

-
Parameters

+
Parameters

 
@@ -1935,7 +2007,7 @@ currently-activating connection that is expected to become the new
 

 
 


 

 

-
Returns

+
Returns

 
 the appropriate NMActiveConnection, if
 any. 

 
[transfer none]

@@ -1971,7 +2043,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

 
@@ -2035,7 +2107,7 @@ nm_client_activate_connection_finish (GError **error);
 
Gets the result of a call to nm_client_activate_connection_async().

 

-
Parameters

+
Parameters

 

 
 

@@ -2062,7 +2134,7 @@ nm_client_activate_connection_finish (
-
Returns

+
Returns

 
 the new NMActiveConnection on success, NULL on
 failure, in which case error
 will be set. 

@@ -2091,7 +2163,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

 

 
 

@@ -2162,7 +2234,7 @@ nm_client_add_and_activate_connection_finish
 
You can call nm_active_connection_get_connection() on the returned
 NMActiveConnection to find the path of the created NMConnection.

 

-
Parameters

+
Parameters

 

 
 

@@ -2189,7 +2261,7 @@ nm_client_add_and_activate_connection_finish
 

 
 


 

 

-
Returns

+
Returns

 
 the new NMActiveConnection on success, NULL on
 failure, in which case error
 will be set. 

@@ -2206,7 +2278,7 @@ nm_client_deactivate_connection (GError **error);

 
Deactivates an active NMActiveConnection.

 

-
Parameters

+
Parameters

 
@@ -2238,7 +2310,7 @@ nm_client_deactivate_connection (
 
 

-
Returns

+
Returns

 
 success or failure

 

 
@@ -2253,7 +2325,7 @@ nm_client_deactivate_connection_async (gpointer user_data);
 
Asynchronously deactivates an active NMActiveConnection.

 

-
Parameters

+
Parameters

 

 
 

@@ -2301,7 +2373,7 @@ nm_client_deactivate_connection_finish
                                 GError **error);
 
Gets the result of a call to nm_client_deactivate_connection_async().

 

-
Parameters

+
Parameters

 

 
 

@@ -2328,7 +2400,7 @@ nm_client_deactivate_connection_finish
 

 
 


 

 

-
Returns

+
Returns

 
 success or failure
@@ -2338,7 +2410,7 @@ nm_client_deactivate_connection_finish 
const GPtrArray *
 nm_client_get_connections (NMClient *client);
-

Parameters

+

Parameters

@@ -2353,7 +2425,7 @@ nm_client_get_connections ( -

Returns

+

Returns

an array containing all connections provided by the remote settings service. The returned array is owned by the NMClient object and should not be modified.

@@ -2369,7 +2441,7 @@ nm_client_get_connection_by_id (Returns the first matching NMRemoteConnection matching a given id .

-

Parameters

+

Parameters

@@ -2391,7 +2463,7 @@ nm_client_get_connection_by_id (
-

Returns

+

Returns

the remote connection object on success, or NULL if no matching object was found.

[transfer none]

@@ -2406,7 +2478,7 @@ nm_client_get_connection_by_path (Returns the NMRemoteConnection representing the connection at path .

-

Parameters

+

Parameters

@@ -2428,7 +2500,7 @@ nm_client_get_connection_by_path (
-

Returns

+

Returns

the remote connection object on success, or NULL if the object was not known.

[transfer none]

@@ -2443,7 +2515,7 @@ nm_client_get_connection_by_uuid (Returns the NMRemoteConnection identified by uuid .

-

Parameters

+

Parameters

@@ -2465,7 +2537,7 @@ nm_client_get_connection_by_uuid (
-

Returns

+

Returns

the remote connection object on success, or NULL if the object was not known.

[transfer none]

@@ -2499,7 +2571,7 @@ identical settings to connection as NetworkManager may perform automatic completion and/or normalization of connection properties.

-

Parameters

+

Parameters

@@ -2552,7 +2624,7 @@ nm_client_add_connection_finish (GError **error);

Gets the result of a call to nm_client_add_connection_async().

-

Parameters

+

Parameters

@@ -2579,7 +2651,7 @@ nm_client_add_connection_finish (
-

Returns

+

Returns

the new NMRemoteConnection on success, NULL on failure, in which case error will be set.

@@ -2608,7 +2680,7 @@ then failures will be set to a NULL-terminated array of the filenames that failed to load.

-

Parameters

+

Parameters

@@ -2646,7 +2718,7 @@ filenames that failed to load.

-

Returns

+

Returns

TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied).

@@ -2665,7 +2737,7 @@ nm_client_load_connections_async (

See nm_client_load_connections() for more details.

-

Parameters

+

Parameters

@@ -2714,7 +2786,7 @@ nm_client_load_connections_finish (Gets the result of an nm_client_load_connections_async() call.

See nm_client_load_connections() for more details.

-

Parameters

+

Parameters

@@ -2747,7 +2819,7 @@ filenames that failed to load.

-

Returns

+

Returns

TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied).

@@ -2764,7 +2836,7 @@ nm_client_reload_connections ( -

Parameters

+

Parameters

@@ -2791,7 +2863,7 @@ the in-memory state matches the on-disk state.

-

Returns

+

Returns

TRUE on success, FALSE on failure

@@ -2807,7 +2879,7 @@ nm_client_reload_connections_async (
-

Parameters

+

Parameters

@@ -2849,7 +2921,7 @@ nm_client_reload_connections_finish (GError **error);

Gets the result of an nm_client_reload_connections_async() call.

-

Parameters

+

Parameters

@@ -2876,7 +2948,7 @@ nm_client_reload_connections_finish (
-

Returns

+

Returns

TRUE on success, FALSE on failure

@@ -2980,6 +3052,12 @@ nm_client_reload_connections_finish (
+

NM_CLIENT_ALL_DEVICES

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

NM_CLIENT_CONNECTIONS

#define NM_CLIENT_CONNECTIONS "connections"
@@ -3016,6 +3094,18 @@ nm_client_reload_connections_finish (
+

NM_CLIENT_ANY_DEVICE_ADDED

+
#define NM_CLIENT_ANY_DEVICE_ADDED "any-device-added"
+
+
+
+
+

NM_CLIENT_ANY_DEVICE_REMOVED

+
#define NM_CLIENT_ANY_DEVICE_REMOVED "any-device-removed"
+
+
+
+

NM_CLIENT_PERMISSION_CHANGED

#define NM_CLIENT_PERMISSION_CHANGED "permission-changed"
@@ -3038,7 +3128,7 @@ nm_client_reload_connections_finish (NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.

-

Members

+

Members

@@ -3158,7 +3248,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

@@ -3207,7 +3297,7 @@ the user requires to obtain a given NMManagerError, NMSettingsError, NMAgentManagerError, and NMConnectionError.

-

Members

+

Members

@@ -3270,6 +3360,15 @@ likely to become the new +

The “all-devices” property

+
  “all-devices”              GPtrArray *
+

List of both real devices and device placeholders.

+

Element-type: NMDevice

+

Flags: Read

+

Since: 1.2

+ +
+

The “can-modify” property

  “can-modify”               gboolean

If TRUE, adding and modifying connections is supported.

@@ -3299,7 +3398,7 @@ permission to read the details of.)

The “devices” property

  “devices”                  GPtrArray *
-

List of known network devices.

+

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

Element-type: NMDevice

Flags: Read

@@ -3319,7 +3418,7 @@ modified by calling Whether the connectivity is metered.

Flags: Read

Default value: 0

-

Since: 1.0.6

+

Since: 1.2

@@ -3421,6 +3520,82 @@ see

Signal Details

+

The “any-device-added” signal

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

Notifies that a NMDevice is added. This signal is emitted for both +regular devices and 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 “any-device-removed” signal

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

Notifies that a NMDevice is removed. This signal is emitted for both +regular devices and 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 “connection-added” signal

void
 user_function (NMClient           *client,
@@ -3428,7 +3603,7 @@ user_function (gpointer            user_data)

Notifies that a NMConnection has been added.

-

Parameters

+

Parameters

@@ -3465,7 +3640,7 @@ user_function (gpointer user_data)

Notifies that a NMConnection has been removed.

-

Parameters

+

Parameters

@@ -3500,9 +3675,10 @@ user_function (NMClient *client, GObject *device, gpointer user_data) -

Notifies that a NMDevice is added.

+

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

-

Parameters

+

Parameters

@@ -3537,9 +3713,10 @@ user_function (NMClient *client, GObject *device, gpointer user_data) -

Notifies that a NMDevice is removed.

+

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

-

Parameters

+

Parameters

@@ -3577,7 +3754,7 @@ user_function (gpointer user_data)

Notifies that a permission has changed

-

Parameters

+

Parameters

-- cgit 1.3.0-6-gf8a5