Description

@@ -977,7 +1054,7 @@ NMClient implements

Functions

nm_client_error_quark ()

GQuark
+GQuark
 nm_client_error_quark (void);
 Registers an error quark for NMClient if necessary.
 
@@ -1123,7 +1200,7 @@ nm_dns_entry_get_priority (
 nm_dns_entry_get_vpn ()
-gboolean
+gboolean
 nm_dns_entry_get_vpn (NMDnsEntry *entry);
 Gets whether the entry refers to VPN name servers.
 
@@ -1143,7 +1220,7 @@ nm_dns_entry_get_vpn (
 Returns
- TRUE if the entry refers to VPN name servers
+ TRUE if the entry refers to VPN name servers
 

 Since: 1.6
 

@@ -1151,8 +1228,8 @@ nm_dns_entry_get_vpn (
 nm_client_new ()
 NMClient *
-nm_client_new (GCancellable *cancellable,
-               GError **error);
+nm_client_new (GCancellable *cancellable,
+               GError **error);

Creates a new NMClient. Note that this will do blocking D-Bus calls to initialize the client. You can use nm_client_new_async() if you want to avoid @@ -1168,12 +1245,12 @@ that. cancellable -a GCancellable, or NULL +a GCancellable, or NULL error -location for a GError, or NULL +location for a GError, or NULL @@ -1188,9 +1265,9 @@ that. nm_client_new_async () void -nm_client_new_async (GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); +nm_client_new_async (GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Creates a new NMClient and begins asynchronously initializing it. callback will be called when it is done; use @@ -1207,7 +1284,7 @@ the callback can be invoked with two first parameters as NULL. cancellable -a GCancellable, or NULL +a GCancellable, or NULL @@ -1229,8 +1306,8 @@ the callback can be invoked with two first parameters as NULL. nm_client_new_finish () NMClient * -nm_client_new_finish (GAsyncResult *result, - GError **error); +nm_client_new_finish (GAsyncResult *result, + GError **error); Gets the result of an nm_client_new_async() call. Parameters @@ -1243,12 +1320,12 @@ nm_client_new_finish (result -a GAsyncResult +a GAsyncResult error -location for a GError, or NULL +location for a GError, or NULL @@ -1256,7 +1333,7 @@ nm_client_new_finish ( Returns - a new NMClient, or NULL on error + a new NMClient, or NULL on error @@ -1282,7 +1359,7 @@ nm_client_get_version ( Returns - string with the version (or NULL if NetworkManager is not running) + string with the version (or NULL if NetworkManager is not running)

@@ -1314,7 +1391,7 @@ nm_client_get_state ( nm_client_get_startup () -gboolean +gboolean nm_client_get_startup (NMClient *client); Tests whether the daemon is still in the process of activating connections at startup. @@ -1341,7 +1418,7 @@ connections at startup. nm_client_get_nm_running () -gboolean +gboolean nm_client_get_nm_running (NMClient *client); Determines whether the daemon is running. @@ -1361,13 +1438,13 @@ nm_client_get_nm_running ( Returns - TRUE if the daemon is running + TRUE if the daemon is running nm_client_networking_get_enabled () -gboolean +gboolean nm_client_networking_get_enabled (NMClient *client); Whether networking is enabled or disabled. @@ -1387,16 +1464,16 @@ nm_client_networking_get_enabled ( Returns - TRUE if networking is enabled, FALSE if networking is disabled + TRUE if networking is enabled, FALSE if networking is disabled nm_client_networking_set_enabled () -gboolean +gboolean nm_client_networking_set_enabled (NMClient *client, - gboolean enabled, - GError **error); + gboolean enabled, + GError **error); Enables or disables networking. When networking is disabled, all controlled interfaces are disconnected and deactivated. When networking is enabled, all controlled interfaces are available for activation. @@ -1416,12 +1493,12 @@ all controlled interfaces are available for activation. enabled -TRUE to set networking enabled, FALSE to set networking disabled +TRUE to set networking enabled, FALSE to set networking disabled error -return location for a GError, or NULL. +return location for a GError, or NULL. [allow-none] @@ -1429,13 +1506,13 @@ all controlled interfaces are available for activation. Returns - TRUE on success, FALSE otherwise + TRUE on success, FALSE otherwise nm_client_wireless_get_enabled () -gboolean +gboolean nm_client_wireless_get_enabled (NMClient *client); Determines whether the wireless is enabled. @@ -1455,7 +1532,7 @@ nm_client_wireless_get_enabled ( Returns - TRUE if wireless is enabled + TRUE if wireless is enabled @@ -1463,7 +1540,7 @@ nm_client_wireless_get_enabled (nm_client_wireless_set_enabled () void nm_client_wireless_set_enabled (NMClient *client, - gboolean enabled); + gboolean enabled); Enables or disables wireless devices. Parameters @@ -1481,7 +1558,7 @@ nm_client_wireless_set_enabled ( enabled -TRUE to enable wireless +TRUE to enable wireless @@ -1491,7 +1568,7 @@ nm_client_wireless_set_enabled ( nm_client_wireless_hardware_get_enabled () -gboolean +gboolean nm_client_wireless_hardware_get_enabled (NMClient *client); Determines whether the wireless hardware is enabled. @@ -1512,13 +1589,13 @@ nm_client_wireless_hardware_get_enabled Returns - TRUE if the wireless hardware is enabled + TRUE if the wireless hardware is enabled nm_client_wwan_get_enabled () -gboolean +gboolean nm_client_wwan_get_enabled (NMClient *client); Determines whether WWAN is enabled. @@ -1538,7 +1615,7 @@ nm_client_wwan_get_enabled ( Returns - TRUE if WWAN is enabled + TRUE if WWAN is enabled @@ -1546,7 +1623,7 @@ nm_client_wwan_get_enabled (nm_client_wwan_set_enabled () void nm_client_wwan_set_enabled (NMClient *client, - gboolean enabled); + gboolean enabled); Enables or disables WWAN devices. Parameters @@ -1564,7 +1641,7 @@ nm_client_wwan_set_enabled (enabled -TRUE to enable WWAN +TRUE to enable WWAN @@ -1574,7 +1651,7 @@ nm_client_wwan_set_enabled ( nm_client_wwan_hardware_get_enabled () -gboolean +gboolean nm_client_wwan_hardware_get_enabled (NMClient *client); Determines whether the WWAN hardware is enabled. @@ -1594,13 +1671,13 @@ nm_client_wwan_hardware_get_enabled ( Returns - TRUE if the WWAN hardware is enabled + TRUE if the WWAN hardware is enabled nm_client_wimax_get_enabled () -gboolean +gboolean nm_client_wimax_get_enabled (NMClient *client); Determines whether WiMAX is enabled. @@ -1620,7 +1697,7 @@ nm_client_wimax_get_enabled ( Returns - TRUE if WiMAX is enabled + TRUE if WiMAX is enabled @@ -1628,7 +1705,7 @@ nm_client_wimax_get_enabled (nm_client_wimax_set_enabled () void nm_client_wimax_set_enabled (NMClient *client, - gboolean enabled); + gboolean enabled); Enables or disables WiMAX devices. Parameters @@ -1646,7 +1723,7 @@ nm_client_wimax_set_enabled (enabled -TRUE to enable WiMAX +TRUE to enable WiMAX @@ -1656,7 +1733,7 @@ nm_client_wimax_set_enabled ( nm_client_wimax_hardware_get_enabled () -gboolean +gboolean nm_client_wimax_hardware_get_enabled (NMClient *client); Determines whether the WiMAX hardware is enabled. @@ -1676,13 +1753,13 @@ nm_client_wimax_hardware_get_enabled ( Returns - TRUE if the WiMAX hardware is enabled + TRUE if the WiMAX hardware is enabled nm_client_connectivity_check_get_available () -gboolean +gboolean nm_client_connectivity_check_get_available (NMClient *client); Determine whether connectivity checking is available. This @@ -1705,14 +1782,14 @@ configuration file. Returns - TRUE if connectivity checking is available. + TRUE if connectivity checking is available. Since: 1.10 nm_client_connectivity_check_get_enabled () -gboolean +gboolean nm_client_connectivity_check_get_enabled (NMClient *client); Determine whether connectivity checking is enabled. @@ -1733,7 +1810,7 @@ nm_client_connectivity_check_get_enabled Returns - TRUE if connectivity checking is enabled. + TRUE if connectivity checking is enabled. Since: 1.10

Enable or disable connectivity checking. Note that if a connectivity checking URI has not been configured, this will not have any effect.

nm_client_set_logging ()

gboolean
+gboolean
 nm_client_set_logging (NMClient *client,
                        const char *level,
                        const char *domains,
-                       GError **error);
+                       GError **error);

Sets NetworkManager logging level and/or domains.

Parameters

@@ -1843,18 +1920,18 @@ nm_client_set_logging (level -logging level to set (NULL or an empty string for no change). +logging level to set (NULL or an empty string for no change). [allow-none] domains logging domains to set. The string should be a list of log -domains separated by ",". (NULL or an empty string for no change). +domains separated by ",". (NULL or an empty string for no change). [allow-none] error -return location for a GError, or NULL. +return location for a GError, or NULL. [allow-none] @@ -1862,7 +1939,7 @@ domains separated by ",". ( Returns - TRUE on success, FALSE otherwise + TRUE on success, FALSE otherwise

@@ -1934,8 +2011,8 @@ connectivity state first before returning any information. nm_client_check_connectivity () NMConnectivityState nm_client_check_connectivity (NMClient *client, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error); Updates the network connectivity state and returns the (new) current state. Contrast nm_client_get_connectivity(), which returns the most recent known state without re-checking. @@ -1957,12 +2034,12 @@ if you do not want to block. cancellable -a GCancellable +a GCancellable error -return location for a GError +return location for a GError @@ -1978,9 +2055,9 @@ if you do not want to block. nm_client_check_connectivity_async () void nm_client_check_connectivity_async (NMClient *client, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Asynchronously updates the network connectivity state and invokes callback when complete. Contrast nm_client_get_connectivity(), @@ -2002,7 +2079,7 @@ re-checking, and cancellable -a GCancellable +a GCancellable @@ -2025,8 +2102,8 @@ re-checking, and nm_client_check_connectivity_finish () NMConnectivityState nm_client_check_connectivity_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Retrieves the result of an nm_client_check_connectivity_async() call. @@ -2045,12 +2122,12 @@ call. result -the GAsyncResult +the GAsyncResult error -return location for a GError +return location for a GError @@ -2064,11 +2141,11 @@ call. nm_client_save_hostname () -gboolean +gboolean nm_client_save_hostname (NMClient *client, const char *hostname, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error); Requests that the machine's persistent hostname be set to the specified value or cleared. @@ -2087,18 +2164,18 @@ or cleared. hostname -the new persistent hostname to set, or NULL to + the new persistent hostname to set, or NULL to clear any existing persistent hostname. [allow-none] cancellable -a GCancellable, or NULL +a GCancellable, or NULL error -return location for GError +return location for GError @@ -2106,7 +2183,7 @@ clear any existing persistent hostname. Returns - TRUE if the request was successful, FALSE if it failed + TRUE if the request was successful, FALSE if it failed @@ -2115,9 +2192,9 @@ clear any existing persistent hostname. void nm_client_save_hostname_async (NMClient *client, const char *hostname, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Requests that the machine's persistent hostname be set to the specified value or cleared. @@ -2136,13 +2213,13 @@ or cleared. hostname -the new persistent hostname to set, or NULL to + the new persistent hostname to set, or NULL to clear any existing persistent hostname. [allow-none] cancellable -a GCancellable, or NULL +a GCancellable, or NULL @@ -2163,10 +2240,10 @@ clear any existing persistent hostname. nm_client_save_hostname_finish () -gboolean +gboolean nm_client_save_hostname_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of an nm_client_save_hostname_async() call. Parameters @@ -2184,12 +2261,12 @@ nm_client_save_hostname_finish ( result -the result passed to the GAsyncReadyCallback +the result passed to the GAsyncReadyCallback error -return location for GError +return location for GError @@ -2197,13 +2274,13 @@ nm_client_save_hostname_finish ( Returns - TRUE if the request was successful, FALSE if it failed + TRUE if the request was successful, FALSE if it failed nm_client_get_devices () -const GPtrArray * +const GPtrArray * nm_client_get_devices (NMClient *client); Gets all the known network devices. Use nm_device_get_type() or the NM_IS_DEVICE_XXXX functions to determine what kind of @@ -2226,7 +2303,7 @@ methods such as Returns -a GPtrArray + 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] @@ -2235,7 +2312,7 @@ containing all the NM nm_client_get_all_devices () -const GPtrArray * +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 @@ -2262,7 +2339,7 @@ use device-specific methods such as Returns -a GPtrArray + 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] @@ -2301,7 +2378,7 @@ nm_client_get_device_by_path ( Returns the NMDevice for the given object_path -or NULL if none is found. +or NULL if none is found. [transfer none] @@ -2337,14 +2414,14 @@ nm_client_get_device_by_iface ( Returns the NMDevice for the given iface -or NULL if none is found. +or NULL if none is found. [transfer none] nm_client_get_active_connections () -const GPtrArray * +const GPtrArray * nm_client_get_active_connections (NMClient *client); Gets the active connections. @@ -2364,7 +2441,7 @@ nm_client_get_active_connections ( Returns -a GPtrArray + a GPtrArray containing all the active NMActiveConnections. The returned array is owned by the client and should not be modified. [transfer none][element-type NMActiveConnection] @@ -2383,7 +2460,7 @@ the default route. If there is a VPN active with the default route, then this function returns the active connection that contains the 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. +non-NetworkManager-recognized device, this will return NULL. Parameters @@ -2444,9 +2521,9 @@ nm_client_activate_connection_async (NMConnection *connection, NMDevice *device, const char *specific_object, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Asynchronously starts a connection to a particular network using the configuration settings from connection and the network device device @@ -2493,7 +2570,7 @@ track the activation to its completion. - + @@ -2526,8 +2603,8 @@ details of the newly added connection. nm_client_activate_connection_finish () NMActiveConnection * nm_client_activate_connection_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of a call to nm_client_activate_connection_async(). Parameters @@ -2545,12 +2622,12 @@ nm_client_activate_connection_finish (result - + - + @@ -2558,7 +2635,7 @@ nm_client_activate_connection_finish ( Returns -the new NMActiveConnection on success, NULL on + the new NMActiveConnection on success, NULL on failure, in which case error will be set. [transfer full] @@ -2573,9 +2650,9 @@ nm_client_add_and_activate_connection_async NMConnection *partial, NMDevice *device, const char *specific_object, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Adds a new connection using the given details (if any) as a template, automatically filling in missing settings with the capabilities of the given device and specific object. The new connection is then asynchronously @@ -2602,7 +2679,7 @@ track the activation to its completion. @@ -2617,7 +2694,7 @@ before being added. - + @@ -2651,8 +2728,8 @@ details of the newly added connection. NMActiveConnection * nm_client_add_and_activate_connection_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + 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. @@ -2672,12 +2749,12 @@ nm_client_add_and_activate_connection_finish - + - + @@ -2685,7 +2762,7 @@ nm_client_add_and_activate_connection_finish Returns -the new NMActiveConnection on success, NULL on + the new NMActiveConnection on success, NULL on failure, in which case error will be set. [transfer full] @@ -2694,11 +2771,11 @@ will be set. nm_client_deactivate_connection () -gboolean +gboolean nm_client_deactivate_connection (NMClient *client, NMActiveConnection *active, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error); Deactivates an active NMActiveConnection. Parameters @@ -2721,12 +2798,12 @@ nm_client_deactivate_connection ( - + - + @@ -2743,9 +2820,9 @@ nm_client_deactivate_connection (void nm_client_deactivate_connection_async (NMClient *client, NMActiveConnection *active, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Asynchronously deactivates an active NMActiveConnection. Parameters @@ -2768,7 +2845,7 @@ nm_client_deactivate_connection_async (cancellable - + @@ -2789,11 +2866,11 @@ nm_client_deactivate_connection_async ( nm_client_deactivate_connection_finish () -gboolean +gboolean nm_client_deactivate_connection_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of a call to nm_client_deactivate_connection_async(). Parameters @@ -2811,12 +2888,12 @@ nm_client_deactivate_connection_finish - + - + @@ -2830,7 +2907,7 @@ nm_client_deactivate_connection_finish nm_client_get_connections () -const GPtrArray * +const GPtrArray * nm_client_get_connections (NMClient *client); Parameters @@ -2889,7 +2966,7 @@ nm_client_get_connection_by_id ( Returns -the remote connection object on success, or NULL if no + 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(). @@ -2928,7 +3005,7 @@ nm_client_get_connection_by_path ( Returns -the remote connection object on success, or NULL if the object was + 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(). @@ -2967,7 +3044,7 @@ nm_client_get_connection_by_uuid ( Returns -the remote connection object on success, or NULL if the object was + 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(). @@ -2980,13 +3057,13 @@ to void nm_client_add_connection_async (NMClient *client, NMConnection *connection, - gboolean save_to_disk, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + gboolean save_to_disk, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Requests that the remote settings service add the given settings to a new connection. If save_to_disk - is TRUE, the connection is immediately written + is TRUE, the connection is immediately written to disk; otherwise it is initially only stored in memory, but may be saved later by calling the connection's nm_remote_connection_commit_changes() method. @@ -3028,7 +3105,7 @@ added, not the object itself - + @@ -3051,8 +3128,8 @@ added, not the object itself nm_client_add_connection_finish () NMRemoteConnection * nm_client_add_connection_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of a call to nm_client_add_connection_async(). Parameters @@ -3070,12 +3147,12 @@ nm_client_add_connection_finish ( - + - + @@ -3083,7 +3160,7 @@ nm_client_add_connection_finish ( Returns -the new NMRemoteConnection on success, NULL on + the new NMRemoteConnection on success, NULL on failure, in which case error will be set. [transfer full] @@ -3092,23 +3169,23 @@ will be set. nm_client_load_connections () -gboolean +gboolean nm_client_load_connections (NMClient *client, char **filenames, char ***failures, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error); Requests that the remote settings service load or reload the given files, adding or updating the connections described within. The changes to the indicated files will not yet be reflected in client 's connections array when the function returns. If all of the indicated files were successfully loaded, the -function will return TRUE, and failures - will be set to NULL. If +function will return TRUE, and failures + will be set to NULL. If NetworkManager tried to load the files, but some (or all) failed, then failures - will be set to a NULL-terminated array of the + will be set to a NULL-terminated array of the filenames that failed to load. Parameters @@ -3126,23 +3203,23 @@ filenames that failed to load. - + - - + - + @@ -3150,9 +3227,9 @@ filenames that failed to load. Returns - TRUE if NetworkManager at least tried to load filenames + TRUE if NetworkManager at least tried to load filenames , -FALSE if an error occurred (eg, permission denied). +FALSE if an error occurred (eg, permission denied). @@ -3161,9 +3238,9 @@ filenames that failed to load. void nm_client_load_connections_async (NMClient *client, char **filenames, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Requests that the remote settings service asynchronously load or reload the given files, adding or updating the connections described within. See nm_client_load_connections() for more details. @@ -3183,12 +3260,12 @@ given files, adding or updating the connections described within. - + - + @@ -3209,11 +3286,11 @@ given files, adding or updating the connections described within. nm_client_load_connections_finish () -gboolean +gboolean nm_client_load_connections_finish (NMClient *client, char ***failures, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of an nm_client_load_connections_async() call. See nm_client_load_connections() for more details. @@ -3233,17 +3310,17 @@ nm_client_load_connections_finish ( +NULL-terminated array of filenames that failed to load. - + - + @@ -3251,18 +3328,18 @@ nm_client_load_connections_finish ( Returns - TRUE if NetworkManager at least tried to load filenames + TRUE if NetworkManager at least tried to load filenames , -FALSE if an error occurred (eg, permission denied). +FALSE if an error occurred (eg, permission denied). nm_client_reload_connections () -gboolean +gboolean nm_client_reload_connections (NMClient *client, - GCancellable *cancellable, - GError **error); + GCancellable *cancellable, + GError **error); Requests that the remote settings service reload all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state. @@ -3282,12 +3359,12 @@ the in-memory state matches the on-disk state. - + - + @@ -3295,7 +3372,7 @@ the in-memory state matches the on-disk state. Returns - TRUE on success, FALSE on failure + TRUE on success, FALSE on failure @@ -3303,9 +3380,9 @@ the in-memory state matches the on-disk state. nm_client_reload_connections_async () void nm_client_reload_connections_async (NMClient *client, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); Requests that the remote settings service begin reloading all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state. @@ -3325,7 +3402,7 @@ in-memory state matches the on-disk state. - + @@ -3346,10 +3423,10 @@ in-memory state matches the on-disk state. nm_client_reload_connections_finish () -gboolean +gboolean nm_client_reload_connections_finish (NMClient *client, - GAsyncResult *result, - GError **error); + GAsyncResult *result, + GError **error); Gets the result of an nm_client_reload_connections_async() call. Parameters @@ -3367,12 +3444,12 @@ nm_client_reload_connections_finish ( - + - + @@ -3380,7 +3457,7 @@ nm_client_reload_connections_finish ( Returns - TRUE on success, FALSE on failure + TRUE on success, FALSE on failure @@ -3406,7 +3483,7 @@ nm_client_get_dns_mode ( Returns - the DNS processing mode, or NULL in case the + the DNS processing mode, or NULL in case the value is not available. Since: 1.6 @@ -3434,7 +3511,7 @@ nm_client_get_dns_rc_manager ( Returns - the resolv.conf manager or NULL in case the + the resolv.conf manager or NULL in case the value is not available. Since: 1.6 @@ -3442,7 +3519,7 @@ value is not available. nm_client_get_dns_configuration () -const GPtrArray * +const GPtrArray * nm_client_get_dns_configuration (NMClient *client); Gets the current DNS configuration @@ -3462,14 +3539,446 @@ nm_client_get_dns_configuration ( Returns -a GPtrArray -containing NMDnsEntry elements or NULL in case the value is not + a GPtrArray +containing NMDnsEntry elements or NULL in case the value is not available. The returned array is owned by the NMClient object and should not be modified. [transfer none][element-type NMDnsEntry] Since: 1.6 + + +nm_client_get_checkpoints () +const GPtrArray * +nm_client_get_checkpoints (NMClient *client); +Gets all the active checkpoints. + +Parameters +specific_object the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of NULL should be used +wired and mobile broadband connections, and the value of NULL should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a NMAccessPoint or NMWimaxNsp owned by device , which you can @@ -2503,7 +2580,7 @@ details of the newly added connection. cancellable a GCancellable, or NULL a GCancellable, or NULL the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error location for a GError, or NULL location for a GError, or NULL partial an NMConnection to add; the connection may be -partially filled (or even NULL) and will be completed by NetworkManager +partially filled (or even NULL) and will be completed by NetworkManager using the given device and specific_object before being added. specific_object the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of NULL should be used +wired and mobile broadband connections, and the value of NULL should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a NMAccessPoint or NMWimaxNsp owned by device , which you can @@ -2627,7 +2704,7 @@ details of the newly added connection. cancellable a GCancellable, or NULL a GCancellable, or NULL result the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error location for a GError, or NULL location for a GError, or NULL cancellable a GCancellable, or NULL a GCancellable, or NULL error location for a GError, or NULL location for a GError, or NULL a GCancellable, or NULL a GCancellable, or NULL result the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error location for a GError, or NULL location for a GError, or NULL cancellable a GCancellable, or NULL a GCancellable, or NULL result the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error location for a GError, or NULL location for a GError, or NULL filenames NULL-terminated array of filenames to load. NULL-terminated array of filenames to load. [array zero-terminated=1] failures on return, a NULL-terminated array of + on return, a NULL-terminated array of filenames that failed to load. [out][transfer full] cancellable a GCancellable, or NULL a GCancellable, or NULL error return location for GError return location for GError filenames NULL-terminated array of filenames to load. NULL-terminated array of filenames to load. [array zero-terminated=1] cancellable a GCancellable, or NULL a GCancellable, or NULL failures on return, a -NULL-terminated array of filenames that failed to load. [out][transfer full][array zero-terminated=1] result the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error location for a GError, or NULL location for a GError, or NULL cancellable a GCancellable, or NULL a GCancellable, or NULL error return location for GError return location for GError cancellable a GCancellable, or NULL a GCancellable, or NULL result the result passed to the GAsyncReadyCallback the result passed to the GAsyncReadyCallback error return location for GError return location for GError +++++ + + + + + + client a NMClient + + +Returns +a GPtrArray +containing all the NMCheckpoint. The returned array is owned by the +NMClient object and should not be modified. +[transfer none][element-type NMCheckpoint] + +Since: 1.12 + + + +nm_client_checkpoint_create () +void +nm_client_checkpoint_create (NMClient *client, + const GPtrArray *devices, + guint32 rollback_timeout, + NMCheckpointCreateFlags flags, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +Creates a checkpoint of the current networking configuration +for given interfaces. An empty devices + argument means all +devices. If rollback_timeout + is not zero, a rollback is +automatically performed after the given timeout. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + client the NMClient devices a list of devices for which a +checkpoint should be created. [element-type NMDevice] rollback_timeout the rollback timeout in seconds flags creation flags cancellable a GCancellable, or NULL callback callback to be called when the add operation completes. [scope async] user_data caller-specific data passed to callback +. [closure] + +Since: 1.12 + + + +nm_client_checkpoint_create_finish () +NMCheckpoint * +nm_client_checkpoint_create_finish (NMClient *client, + GAsyncResult *result, + GError **error); +Gets the result of a call to nm_client_checkpoint_create(). + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the NMClient result the result passed to the GAsyncReadyCallback error location for a GError, or NULL + + +Returns +the new NMCheckpoint on success, NULL on +failure, in which case error +will be set. +[transfer full] + +Since: 1.12 + + + +nm_client_checkpoint_destroy () +void +nm_client_checkpoint_destroy (NMClient *client, + const char *checkpoint_path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +Destroys an existing checkpoint without performing a rollback. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + client the NMClient checkpoint_path the D-Bus path for the checkpoint cancellable a GCancellable, or NULL callback callback to be called when the add operation completes. [scope async] user_data caller-specific data passed to callback +. [closure] + +Since: 1.12 + + + +nm_client_checkpoint_destroy_finish () +gboolean +nm_client_checkpoint_destroy_finish (NMClient *client, + GAsyncResult *result, + GError **error); +Gets the result of a call to nm_client_checkpoint_destroy(). + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client an NMClient result the result passed to the GAsyncReadyCallback error location for a GError, or NULL + + +Returns + TRUE on success or FALSE on failure, in which case +error +will be set. + +Since: 1.12 + + + +nm_client_checkpoint_rollback () +void +nm_client_checkpoint_rollback (NMClient *client, + const char *checkpoint_path, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +Performs the rollback of a checkpoint before the timeout is reached. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + client the NMClient checkpoint_path the D-Bus path to the checkpoint cancellable a GCancellable, or NULL callback callback to be called when the add operation completes. [scope async] user_data caller-specific data passed to callback +. [closure] + +Since: 1.12 + + + +nm_client_checkpoint_rollback_finish () +GHashTable * +nm_client_checkpoint_rollback_finish (NMClient *client, + GAsyncResult *result, + GError **error); +Gets the result of a call to nm_client_checkpoint_rollback(). + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client an NMClient result the result passed to the GAsyncReadyCallback error location for a GError, or NULL + + +Returns +an hash table of +devices and results. Devices are represented by their original +D-Bus path; each result is a NMRollbackResult. +[transfer full][element-type utf8 guint32] + +Since: 1.12 + + + +nm_client_checkpoint_adjust_rollback_timeout () +void +nm_client_checkpoint_adjust_rollback_timeout + (NMClient *client, + const char *checkpoint_path, + guint32 add_timeout, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); +Resets the timeout for the checkpoint with path checkpoint_path + +to timeout_add +. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + client the NMClient checkpoint_path a D-Bus path to a checkpoint add_timeout the timeout in seconds counting from now. +Set to zero, to disable the timeout. cancellable a GCancellable, or NULL callback callback to be called when the add operation completes. [scope async] user_data caller-specific data passed to callback +. [closure] + +Since: 1.12 + + + +nm_client_checkpoint_adjust_rollback_timeout_finish () +gboolean +nm_client_checkpoint_adjust_rollback_timeout_finish + (NMClient *client, + GAsyncResult *result, + GError **error); +Gets the result of a call to nm_client_checkpoint_adjust_rollback_timeout(). + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client an NMClient result the result passed to the GAsyncReadyCallback error location for a GError, or NULL + + +Returns + TRUE on success or FALSE on failure. + +Since: 1.12 + Types and Values @@ -3956,37 +4465,46 @@ likely to become the new The “active-connections” property - “active-connections” GPtrArray * + “active-connections” GPtrArray * The active connections. -Element-type: NMActiveConnection +[type GPtrArray(NMActiveConnection)] Flags: Read The “all-devices” property - “all-devices” GPtrArray * + “all-devices” GPtrArray * List of both real devices and device placeholders. -Element-type: NMDevice +[type GPtrArray(NMDevice)] Flags: Read Since: 1.2 The “can-modify” property - “can-modify” gboolean -If TRUE, adding and modifying connections is supported. + “can-modify” gboolean +If TRUE, adding and modifying connections is supported. Flags: Read Default value: FALSE +The “checkpoints” property + “checkpoints” GPtrArray * +The list of active checkpoints. +[type GPtrArray(NMCheckpoint)] +Flags: Read +Since: 1.12 + + + The “connections” property - “connections” GPtrArray * + “connections” GPtrArray * The list of configured connections that are available to the user. (Note that this differs from the underlying D-Bus property, which may also contain the object paths of connections that the user does not have permission to read the details of.) -Element-type: NMRemoteConnection +[type GPtrArray(NMRemoteConnection)] Flags: Read @@ -4000,29 +4518,29 @@ permission to read the details of.) The “connectivity-check-available” property - “connectivity-check-available” gboolean + “connectivity-check-available” gboolean Flags: Read Default value: FALSE The “connectivity-check-enabled” property - “connectivity-check-enabled” gboolean + “connectivity-check-enabled” gboolean Flags: Read / Write Default value: FALSE The “devices” property - “devices” GPtrArray * + “devices” GPtrArray * List of real network devices. Does not include placeholder devices. -Element-type: NMDevice +[type GPtrArray(NMDevice)] Flags: Read The “dns-configuration” property - “dns-configuration” GPtrArray * + “dns-configuration” GPtrArray * The current DNS configuration represented as an array of dictionaries. Each dictionary has the "nameservers", "priority" keys and, optionally, "interface" and "vpn". @@ -4030,13 +4548,14 @@ dictionaries. Each dictionary has the "nameservers", relative priority, "interface" the interface on which these servers are contacted, "vpn" a boolean telling whether the configuration was obtained from a VPN connection. +[type GPtrArray(GVariant)] Flags: Read Since: 1.6 The “dns-mode” property - “dns-mode” gchar * + “dns-mode” gchar * The current DNS processing mode. Flags: Read Default value: "" @@ -4045,7 +4564,7 @@ configuration was obtained from a VPN connection. The “dns-rc-manager” property - “dns-rc-manager” gchar * + “dns-rc-manager” gchar * The current resolv.conf management mode. Flags: Read Default value: "" @@ -4054,7 +4573,7 @@ configuration was obtained from a VPN connection. The “hostname” property - “hostname” gchar * + “hostname” gchar * The machine hostname stored in persistent configuration. This can be modified by calling nm_client_save_hostname(). Flags: Read @@ -4063,7 +4582,7 @@ modified by calling The “metered” property - “metered” guint + “metered” guint Whether the connectivity is metered. Flags: Read Default value: 0 @@ -4072,7 +4591,7 @@ modified by calling The “networking-enabled” property - “networking-enabled” gboolean + “networking-enabled” gboolean Whether networking is enabled. Flags: Read / Write Default value: TRUE @@ -4080,7 +4599,7 @@ modified by calling The “nm-running” property - “nm-running” gboolean + “nm-running” gboolean Whether the daemon is running. Flags: Read Default value: FALSE @@ -4096,7 +4615,7 @@ see The “startup” property - “startup” gboolean + “startup” gboolean Whether the daemon is still starting up. Flags: Read Default value: FALSE @@ -4112,7 +4631,7 @@ see The “version” property - “version” gchar * + “version” gchar * The NetworkManager version. Flags: Read Default value: NULL @@ -4120,7 +4639,7 @@ see The “wimax-enabled” property - “wimax-enabled” gboolean + “wimax-enabled” gboolean Whether WiMAX functionality is enabled. Flags: Read / Write Default value: FALSE @@ -4128,7 +4647,7 @@ see The “wimax-hardware-enabled” property - “wimax-hardware-enabled” gboolean + “wimax-hardware-enabled” gboolean Whether the WiMAX hardware is enabled. Flags: Read Default value: FALSE @@ -4136,7 +4655,7 @@ see The “wireless-enabled” property - “wireless-enabled” gboolean + “wireless-enabled” gboolean Whether wireless is enabled. Flags: Read / Write Default value: FALSE @@ -4144,7 +4663,7 @@ see The “wireless-hardware-enabled” property - “wireless-hardware-enabled” gboolean + “wireless-hardware-enabled” gboolean Whether the wireless hardware is enabled. Flags: Read Default value: TRUE @@ -4152,7 +4671,7 @@ see The “wwan-enabled” property - “wwan-enabled” gboolean + “wwan-enabled” gboolean Whether WWAN functionality is enabled. Flags: Read / Write Default value: FALSE @@ -4160,7 +4679,7 @@ see The “wwan-hardware-enabled” property - “wwan-hardware-enabled” gboolean + “wwan-hardware-enabled” gboolean Whether the WWAN hardware is enabled. Flags: Read Default value: FALSE @@ -4173,7 +4692,7 @@ see void user_function (NMClient *client, NMActiveConnection *active_connection, - gpointer user_data) + gpointer user_data) Notifies that a NMActiveConnection has been added. Parameters @@ -4202,7 +4721,7 @@ user_function ( -Flags: Run First +Flags: Run First @@ -4210,7 +4729,7 @@ user_function (void user_function (NMClient *client, NMActiveConnection *active_connection, - gpointer user_data) + gpointer user_data) Notifies that a NMActiveConnection has been removed. Parameters @@ -4239,15 +4758,15 @@ user_function ( -Flags: Run First +Flags: Run First

client	the `NMClient`
devices	a list of devices for which a -checkpoint should be created.	[element-type NMDevice]
rollback_timeout	the rollback timeout in seconds
flags	creation flags
cancellable	a GCancellable, or `NULL`
callback	callback to be called when the add operation completes.	[scope async]
user_data	caller-specific data passed to `callback` -.	[closure]

client	the NMClient
result	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`

client	the `NMClient`
checkpoint_path	the D-Bus path for the checkpoint
cancellable	a GCancellable, or `NULL`
callback	callback to be called when the add operation completes.	[scope async]
user_data	caller-specific data passed to `callback` -.	[closure]

client	an NMClient
result	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`

specific_object	the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of `NULL` should be used +wired and mobile broadband connections, and the value of `NULL` should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a NMAccessPoint or NMWimaxNsp owned by `device` , which you can @@ -2503,7 +2580,7 @@ details of the newly added connection.
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`	location for a GError, or `NULL`
partial	an NMConnection to add; the connection may be -partially filled (or even `NULL`) and will be completed by NetworkManager +partially filled (or even `NULL`) and will be completed by NetworkManager using the given `device` and `specific_object` before being added.	specific_object	the object path of a connection-type-specific object this activation should use. This parameter is currently ignored for -wired and mobile broadband connections, and the value of `NULL` should be used +wired and mobile broadband connections, and the value of `NULL` should be used (ie, no specific object). For Wi-Fi or WiMAX connections, pass the object path of a NMAccessPoint or NMWimaxNsp owned by `device` , which you can @@ -2627,7 +2704,7 @@ details of the newly added connection.
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
result	the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`	location for a GError, or `NULL`
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
error	location for a GError, or `NULL`	location for a GError, or `NULL`
a GCancellable, or `NULL`	a GCancellable, or `NULL`
result	the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`	location for a GError, or `NULL`
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
result	the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`	location for a GError, or `NULL`
filenames	`NULL`-terminated array of filenames to load.	`NULL`-terminated array of filenames to load.	[array zero-terminated=1]
failures	on return, a `NULL`-terminated array of +	on return, a `NULL`-terminated array of filenames that failed to load.	[out][transfer full]
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
error	return location for GError	return location for GError
filenames	`NULL`-terminated array of filenames to load.	`NULL`-terminated array of filenames to load.	[array zero-terminated=1]
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
failures	on return, a -`NULL`-terminated array of filenames that failed to load.	[out][transfer full][array zero-terminated=1]
result	the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	location for a GError, or `NULL`	location for a GError, or `NULL`
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
error	return location for GError	return location for GError
cancellable	a GCancellable, or `NULL`	a GCancellable, or `NULL`
result	the result passed to the GAsyncReadyCallback	the result passed to the GAsyncReadyCallback
error	return location for GError	return location for GError

nm_client_get_checkpoints ()

Parameters

Returns

nm_client_checkpoint_create ()

Parameters

nm_client_checkpoint_create_finish ()

Parameters

Returns

nm_client_checkpoint_destroy ()

Parameters

nm_client_checkpoint_destroy_finish ()

Parameters

Returns

nm_client_checkpoint_rollback ()

Parameters

nm_client_checkpoint_rollback_finish ()

Parameters

Returns

nm_client_checkpoint_adjust_rollback_timeout ()

Parameters

nm_client_checkpoint_adjust_rollback_timeout_finish ()

Parameters

Returns

Types and Values

The “active-connections” property

The “all-devices” property

The “checkpoints” property

The “connections” property

The “devices” property

Implemented Interfaces

Description

Functions

nm_client_error_quark ()

nm_dns_entry_get_vpn ()

Returns

nm_client_new ()

nm_client_new_async ()

nm_client_new_finish ()

Parameters

Returns

Returns

nm_client_get_startup ()

nm_client_get_nm_running ()

Returns

nm_client_networking_get_enabled ()

Returns

nm_client_networking_set_enabled ()

Returns

nm_client_wireless_get_enabled ()

Returns

nm_client_wireless_set_enabled ()

Parameters

nm_client_wireless_hardware_get_enabled ()

Returns

nm_client_wwan_get_enabled ()

Returns

nm_client_wwan_set_enabled ()

Parameters

nm_client_wwan_hardware_get_enabled ()

Returns

nm_client_wimax_get_enabled ()

Returns

nm_client_wimax_set_enabled ()

Parameters

nm_client_wimax_hardware_get_enabled ()

Returns

nm_client_connectivity_check_get_available ()

Returns

nm_client_connectivity_check_get_enabled ()

Returns

nm_client_get_logging ()

Parameters

Returns

nm_client_set_logging ()

Parameters

Returns

nm_client_check_connectivity ()

nm_client_check_connectivity_async ()

nm_client_check_connectivity_finish ()

nm_client_save_hostname ()

The `“active-connections”` property

The `“all-devices”` property

The `“checkpoints”` property

The `“connections”` property

The `“devices”` property

The `“active-connections”` property