From 73e152af6e3fb4f5848bfb8394484026ff119003 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 11 May 2016 17:08:25 +0200 Subject: Imported Upstream version 1.2.2 --- docs/libnm/html/NMClient.html | 258 ++++++++++++++++++++++-------------------- 1 file changed, 137 insertions(+), 121 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index a990346a..e5449080 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -16,7 +16,8 @@ Top  |  Description  |  - Object Hierarchy  |  + Object Hierarchy  |  + Implemented Interfaces  |  Properties  |  Signals @@ -788,12 +789,16 @@ #define NM_CLIENT_ERROR + +  +NMClient +

Object Hierarchy

-
    GEnum
+
    GEnum
     ├── NMClientError
     ├── NMClientPermission
     ╰── NMClientPermissionResult
@@ -802,6 +807,12 @@
+

Implemented Interfaces

+

+NMClient implements + GInitable and GAsyncInitable.

+
+

Description

@@ -812,7 +823,7 @@ nm_client_error_quark (void);

Registers an error quark for NMClient if necessary.

-

Returns

+

Returns

the error quark used for NMClient errors.

@@ -827,7 +838,7 @@ nm_client_new (GCancellablenm_client_new_async() if you want to avoid that.

-

Parameters

+

Parameters

@@ -849,7 +860,7 @@ that.

-

Returns

+

Returns

a new NMClient or NULL on an error

@@ -866,7 +877,7 @@ nm_client_new_async (GCancellable nm_client_new_finish() to get the result. Note that on an error, the callback can be invoked with two first parameters as NULL.

-

Parameters

+

Parameters

@@ -902,7 +913,7 @@ nm_client_new_finish (GAsyncResul GError **error);

Gets the result of an nm_client_new_async() call.

-

Parameters

+

Parameters

@@ -924,7 +935,7 @@ nm_client_new_finish (GAsyncResul
-

Returns

+

Returns

a new NMClient, or NULL on error

@@ -935,7 +946,7 @@ nm_client_new_finish (GAsyncResul nm_client_get_version (NMClient *client);

Gets NetworkManager version.

-

Parameters

+

Parameters

@@ -950,7 +961,7 @@ nm_client_get_version ( -

Returns

+

Returns

string with the version (or NULL if NetworkManager is not running)

@@ -961,7 +972,7 @@ nm_client_get_version (NMClient *client);

Gets the current daemon state.

-

Parameters

+

Parameters

@@ -976,7 +987,7 @@ nm_client_get_state ( -

Returns

+

Returns

the current NMState

@@ -988,7 +999,7 @@ nm_client_get_startup ( -

Parameters

+

Parameters

@@ -1003,7 +1014,7 @@ connections at startup.

-

Returns

+

Returns

whether the daemon is still starting up

@@ -1014,7 +1025,7 @@ connections at startup.

nm_client_get_nm_running (NMClient *client);

Determines whether the daemon is running.

-

Parameters

+

Parameters

@@ -1029,7 +1040,7 @@ nm_client_get_nm_running ( -

Returns

+

Returns

TRUE if the daemon is running

@@ -1040,7 +1051,7 @@ nm_client_get_nm_running (NMClient *client);

Whether networking is enabled or disabled.

-

Parameters

+

Parameters

@@ -1055,7 +1066,7 @@ nm_client_networking_get_enabled (
-

Returns

+

Returns

TRUE if networking is enabled, FALSE if networking is disabled

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

Parameters

+

Parameters

@@ -1097,7 +1108,7 @@ all controlled interfaces are available for activation.

-

Returns

+

Returns

TRUE on success, FALSE otherwise

@@ -1108,7 +1119,7 @@ all controlled interfaces are available for activation.

nm_client_wireless_get_enabled (NMClient *client);

Determines whether the wireless is enabled.

-

Parameters

+

Parameters

@@ -1123,7 +1134,7 @@ nm_client_wireless_get_enabled (
-

Returns

+

Returns

TRUE if wireless is enabled

@@ -1135,7 +1146,7 @@ nm_client_wireless_set_enabled (gboolean enabled);

Enables or disables wireless devices.

-

Parameters

+

Parameters

@@ -1165,7 +1176,7 @@ nm_client_wireless_hardware_get_enabled (NMClient *client);

Determines whether the wireless hardware is enabled.

-

Parameters

+

Parameters

@@ -1180,7 +1191,7 @@ nm_client_wireless_hardware_get_enabled
-

Returns

+

Returns

TRUE if the wireless hardware is enabled

@@ -1191,7 +1202,7 @@ nm_client_wireless_hardware_get_enabled nm_client_wwan_get_enabled (NMClient *client);

Determines whether WWAN is enabled.

-

Parameters

+

Parameters

@@ -1206,7 +1217,7 @@ nm_client_wwan_get_enabled ( -

Returns

+

Returns

TRUE if WWAN is enabled

@@ -1218,7 +1229,7 @@ nm_client_wwan_set_enabled (gboolean enabled);

Enables or disables WWAN devices.

-

Parameters

+

Parameters

@@ -1247,7 +1258,7 @@ nm_client_wwan_set_enabled (NMClient *client);

Determines whether the WWAN hardware is enabled.

-

Parameters

+

Parameters

@@ -1262,7 +1273,7 @@ nm_client_wwan_hardware_get_enabled (
-

Returns

+

Returns

TRUE if the WWAN hardware is enabled

@@ -1273,7 +1284,7 @@ nm_client_wwan_hardware_get_enabled (NMClient *client);

Determines whether WiMAX is enabled.

-

Parameters

+

Parameters

@@ -1288,7 +1299,7 @@ nm_client_wimax_get_enabled ( -

Returns

+

Returns

TRUE if WiMAX is enabled

@@ -1300,7 +1311,7 @@ nm_client_wimax_set_enabled (gboolean enabled);

Enables or disables WiMAX devices.

-

Parameters

+

Parameters

@@ -1329,7 +1340,7 @@ nm_client_wimax_set_enabled (NMClient *client);

Determines whether the WiMAX hardware is enabled.

-

Parameters

+

Parameters

@@ -1344,7 +1355,7 @@ nm_client_wimax_hardware_get_enabled ( -

Returns

+

Returns

TRUE if the WiMAX hardware is enabled

@@ -1358,7 +1369,7 @@ nm_client_get_logging (GError **error);

Gets NetworkManager current logging level and domains.

-

Parameters

+

Parameters

@@ -1391,7 +1402,7 @@ a list of domains separated by ",".

-

Returns

+

Returns

TRUE on success, FALSE otherwise

@@ -1405,7 +1416,7 @@ nm_client_set_logging (GError **error);

Sets NetworkManager logging level and/or domains.

-

Parameters

+

Parameters

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

Returns

+

Returns

TRUE on success, FALSE otherwise

@@ -1451,7 +1462,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

@@ -1473,7 +1484,7 @@ client can or cannot perform the action the permission represents

-

Returns

+

Returns

the permission's result, one of NMClientPermissionResult

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

-

Parameters

+

Parameters

@@ -1502,7 +1513,7 @@ connectivity state first before returning any information.

-

Returns

+

Returns

the current connectivity state

@@ -1519,7 +1530,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

@@ -1546,7 +1557,7 @@ if you do not want to block.

-

Returns

+

Returns

the (new) current connectivity state

@@ -1564,7 +1575,7 @@ nm_client_check_connectivity_async (nm_client_check_connectivity(), which blocks.

-

Parameters

+

Parameters

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

-

Parameters

+

Parameters

@@ -1634,7 +1645,7 @@ call.

-

Returns

+

Returns

the (new) current connectivity state

@@ -1649,7 +1660,7 @@ nm_client_save_hostname ( -

Parameters

+

Parameters

@@ -1682,7 +1693,7 @@ clear any existing persistent hostname.

-

Returns

+

Returns

TRUE if the request was successful, FALSE if it failed

@@ -1698,7 +1709,7 @@ nm_client_save_hostname_async (Requests that the machine's persistent hostname be set to the specified value or cleared.

-

Parameters

+

Parameters

@@ -1746,7 +1757,7 @@ nm_client_save_hostname_finish (GError **error);

Gets the result of an nm_client_save_hostname_async() call.

-

Parameters

+

Parameters

@@ -1773,7 +1784,7 @@ nm_client_save_hostname_finish (
-

Returns

+

Returns

TRUE if the request was successful, FALSE if it failed

@@ -1787,7 +1798,7 @@ nm_client_get_devices (nm_device_ethernet_get_hw_address().

-

Parameters

+

Parameters

@@ -1802,7 +1813,7 @@ methods such as -

Returns

+

Returns

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

@@ -1823,7 +1834,7 @@ a placeholder.

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

+

Parameters

@@ -1838,7 +1849,7 @@ use device-specific methods such as -

Returns

+

Returns

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

@@ -1854,7 +1865,7 @@ nm_client_get_device_by_path (const char *object_path);

Gets a NMDevice from a NMClient.

-

Parameters

+

Parameters

@@ -1876,7 +1887,7 @@ nm_client_get_device_by_path ( -

Returns

+

Returns

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

[transfer none]

@@ -1890,7 +1901,7 @@ nm_client_get_device_by_iface (const char *iface);

Gets a NMDevice from a NMClient.

-

Parameters

+

Parameters

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

Returns

+

Returns

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

[transfer none]

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

nm_client_get_active_connections (NMClient *client);

Gets the active connections.

-

Parameters

+

Parameters

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

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

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

Returns

+

Returns

the appropriate NMActiveConnection, if any.

[transfer none]

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

-

Parameters

+

Parameters

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

Returns

+

Returns

the appropriate NMActiveConnection, if any.

[transfer none]

@@ -2018,7 +2029,7 @@ any.

nm_client_activate_connection_async ()

void
 nm_client_activate_connection_async (NMClient *client,
-                                     NMConnection *connection,
+                                     NMConnection *connection,
                                      NMDevice *device,
                                      const char *specific_object,
                                      GCancellable *cancellable,
@@ -2043,7 +2054,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

 
@@ -2058,7 +2069,7 @@ track the activation to its completion.

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

 

-
Parameters

+
Parameters

 

 
 

 
 

 
connection
 an NMConnection. 
 an NMConnection. 

 [allow-none]
 

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

+
Returns

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

@@ -2147,7 +2158,7 @@ will be set. 

 
void
 nm_client_add_and_activate_connection_async
                                (NMClient *client,
-                                NMConnection *partial,
+                                NMConnection *partial,
                                 NMDevice *device,
                                 const char *specific_object,
                                 GCancellable *cancellable,
@@ -2163,7 +2174,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

 

 
 

@@ -2178,7 +2189,7 @@ track the activation to its completion.

 
 
-

 
 


 
partial
 an NMConnection to add; the connection may be
+
 an NMConnection to add; the connection may be
 partially filled (or even NULL) and will be completed by NetworkManager
 using the given device
 and specific_object
@@ -2232,9 +2243,9 @@ nm_client_add_and_activate_connection_finish
                                 GError **error);
 
Gets the result of a call to nm_client_add_and_activate_connection_async().

 
You can call nm_active_connection_get_connection() on the returned
-NMActiveConnection to find the path of the created NMConnection.

+NMActiveConnection to find the path of the created NMConnection.

 

-
Parameters

+
Parameters

 
@@ -2261,7 +2272,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. 

@@ -2278,7 +2289,7 @@ nm_client_deactivate_connection (GError **error);
 
Deactivates an active NMActiveConnection.

 

-
Parameters

+
Parameters

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

-
Returns

+
Returns

 
 success or failure

 

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

 

-
Parameters

+
Parameters

 

 
 

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

 

-
Parameters

+
Parameters

 

 
 

@@ -2400,7 +2411,7 @@ nm_client_deactivate_connection_finish
 

 
 


 

 

-
Returns

+
Returns

 
 success or failure

 

 

@@ -2410,7 +2421,7 @@ nm_client_deactivate_connection_finish
 
const GPtrArray *
 nm_client_get_connections (NMClient *client);

 

-
Parameters

+
Parameters

 
@@ -2425,12 +2436,12 @@ 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.

 
The connections are as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none][element-type NMRemoteConnection]

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

 

-
Parameters

+
Parameters

 

 
 

@@ -2465,11 +2476,11 @@ nm_client_get_connection_by_id (
 
 

-
Returns

+
Returns

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

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 

 
@@ -2482,7 +2493,7 @@ nm_client_get_connection_by_path (Returns the NMRemoteConnection representing the connection at path
 .

 

-
Parameters

+
Parameters

 

 
 

@@ -2504,11 +2515,11 @@ nm_client_get_connection_by_path (
 
 

-
Returns

+
Returns

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

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 

 
@@ -2521,7 +2532,7 @@ nm_client_get_connection_by_uuid (Returns the NMRemoteConnection identified by uuid
 .

 

-
Parameters

+
Parameters

 

 
 

@@ -2543,11 +2554,11 @@ nm_client_get_connection_by_uuid (
 
 

-
Returns

+
Returns

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

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 

 
@@ -2556,7 +2567,7 @@ to 
nm_client_add_connection_async ()

 
void
 nm_client_add_connection_async (NMClient *client,
-                                NMConnection *connection,
+                                NMConnection *connection,
                                 gboolean save_to_disk,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
@@ -2579,7 +2590,7 @@ identical settings to connection
  as NetworkManager may perform automatic
 completion and/or normalization of connection properties.

 

-
Parameters

+
Parameters

 

 
 

@@ -2632,7 +2643,7 @@ nm_client_add_connection_finish (GError **error);
 
Gets the result of a call to nm_client_add_connection_async().

 

-
Parameters

+
Parameters

 

 
 

@@ -2659,7 +2670,7 @@ nm_client_add_connection_finish (
 
 

-
Returns

+
Returns

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

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

 

-
Parameters

+
Parameters

 

 
 

@@ -2726,7 +2737,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).

@@ -2745,7 +2756,7 @@ nm_client_load_connections_async (
 
See nm_client_load_connections() for more details.

 

-
Parameters

+
Parameters

 
@@ -2794,7 +2805,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

 

 
 

@@ -2827,7 +2838,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).

@@ -2844,7 +2855,7 @@ nm_client_reload_connections (
-
Parameters

+
Parameters

 
@@ -2871,7 +2882,7 @@ the in-memory state matches the on-disk state.

 
 

 

 

 

-
Returns

+
Returns

 
 TRUE on success, FALSE on failure

 

 

@@ -2887,7 +2898,7 @@ nm_client_reload_connections_async (
 

-
Parameters

+
Parameters

 
@@ -2929,7 +2940,7 @@ nm_client_reload_connections_finish (GError **error);
 
Gets the result of an nm_client_reload_connections_async() call.

 

-
Parameters

+
Parameters

 

 
 

@@ -2956,7 +2967,7 @@ nm_client_reload_connections_finish (
 
 

-
Returns

+
Returns

 
 TRUE on success, FALSE on failure

 

 
@@ -3136,7 +3147,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

 

 
 

@@ -3256,7 +3267,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

 

 
 

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

 

-
Members

+
Members

 

 
 

@@ -3348,6 +3359,11 @@ the user requires to obtain a given #define NM_CLIENT_ERROR nm_client_error_quark ()
 
 
+

+

+
NMClient

+
typedef struct _NMClient NMClient;

+

 
 

 
Property Details

@@ -3536,7 +3552,7 @@ user_function (Notifies that a NMDevice is added.  This signal is emitted for both
 regular devices and placeholder devices.

 

-
Parameters

+
Parameters

 

 
 

@@ -3574,7 +3590,7 @@ user_function (Notifies that a NMDevice is removed.  This signal is emitted for both
 regular devices and placeholder devices.

 

-
Parameters

+
Parameters

 

 
 

@@ -3609,9 +3625,9 @@ regular devices and placeholder devices.

 user_function (NMClient           *client,
                NMRemoteConnection *connection,
                gpointer            user_data)
-
Notifies that a NMConnection has been added.

+
Notifies that a NMConnection has been added.

 

-
Parameters

+
Parameters

 

 
 

@@ -3646,9 +3662,9 @@ user_function (NMClient           *client,
                NMRemoteConnection *connection,
                gpointer            user_data)
-
Notifies that a NMConnection has been removed.

+
Notifies that a NMConnection has been removed.

 

-
Parameters

+
Parameters

 

 
 

@@ -3686,7 +3702,7 @@ user_function (Notifies that a NMDevice is added.  This signal is not emitted for
 placeholder devices.

 

-
Parameters

+
Parameters

 

 
 

@@ -3724,7 +3740,7 @@ user_function (Notifies that a NMDevice is removed.  This signal is not emitted for
 placeholder devices.

 

-
Parameters

+
Parameters

 

 
 

@@ -3762,7 +3778,7 @@ user_function (gpointer  user_data)
 
Notifies that a permission has changed

 

-
Parameters

+
Parameters

 

 
 

-- 
cgit 1.3.0-6-gf8a5