Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- docs/libnm/html/NMClient.html | 357 ++++++++++++++++++++++++++++-------------- 1 file changed, 238 insertions(+), 119 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index 06167333..8b26d625 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -8,7 +8,7 @@ - + @@ -617,6 +617,16 @@ void +active-connection-added +Run First + + +void +active-connection-removed +Run First + + +void any-device-added Run First @@ -774,6 +784,14 @@ NM_CLIENT_CONNECTION_REMOVED +#define +NM_CLIENT_ACTIVE_CONNECTION_ADDED + + +#define +NM_CLIENT_ACTIVE_CONNECTION_REMOVED + + enum NMClientPermission @@ -823,7 +841,7 @@ NMClient implements nm_client_error_quark (void);

Registers an error quark for NMClient if necessary.

Returns

the error quark used for NMClient errors.

@@ -838,7 +856,7 @@ nm_client_new (GCancellablenm_client_new_async() if you want to avoid that. -Parameters +Parameters @@ -860,7 +878,7 @@ that. -Returns +Returns a new NMClient or NULL on an error @@ -877,7 +895,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 @@ -913,7 +931,7 @@ nm_client_new_finish (GAsyncResul GError **error); Gets the result of an nm_client_new_async() call. -Parameters +Parameters @@ -935,7 +953,7 @@ nm_client_new_finish (GAsyncResul -Returns +Returns a new NMClient, or NULL on error @@ -946,7 +964,7 @@ nm_client_new_finish (GAsyncResul nm_client_get_version (NMClient *client); Gets NetworkManager version. -Parameters +Parameters @@ -961,7 +979,7 @@ nm_client_get_version ( -Returns +Returns string with the version (or NULL if NetworkManager is not running) @@ -972,7 +990,7 @@ nm_client_get_version (NMClient *client); Gets the current daemon state. -Parameters +Parameters @@ -987,7 +1005,7 @@ nm_client_get_state ( -Returns +Returns the current NMState @@ -999,7 +1017,7 @@ nm_client_get_startup ( -Parameters +Parameters @@ -1014,7 +1032,7 @@ connections at startup. -Returns +Returns whether the daemon is still starting up @@ -1025,7 +1043,7 @@ connections at startup. nm_client_get_nm_running (NMClient *client); Determines whether the daemon is running. -Parameters +Parameters @@ -1040,7 +1058,7 @@ nm_client_get_nm_running ( -Returns +Returns TRUE if the daemon is running @@ -1051,7 +1069,7 @@ nm_client_get_nm_running (NMClient *client); Whether networking is enabled or disabled. -Parameters +Parameters @@ -1066,7 +1084,7 @@ nm_client_networking_get_enabled ( -Returns +Returns TRUE if networking is enabled, FALSE if networking is disabled @@ -1081,7 +1099,7 @@ nm_client_networking_set_enabled ( -Parameters +Parameters @@ -1108,7 +1126,7 @@ all controlled interfaces are available for activation. -Returns +Returns TRUE on success, FALSE otherwise @@ -1119,7 +1137,7 @@ all controlled interfaces are available for activation. nm_client_wireless_get_enabled (NMClient *client); Determines whether the wireless is enabled. -Parameters +Parameters @@ -1134,7 +1152,7 @@ nm_client_wireless_get_enabled ( -Returns +Returns TRUE if wireless is enabled @@ -1146,7 +1164,7 @@ nm_client_wireless_set_enabled (gboolean enabled); Enables or disables wireless devices. -Parameters +Parameters @@ -1176,7 +1194,7 @@ nm_client_wireless_hardware_get_enabled (NMClient *client); Determines whether the wireless hardware is enabled. -Parameters +Parameters @@ -1191,7 +1209,7 @@ nm_client_wireless_hardware_get_enabled -Returns +Returns TRUE if the wireless hardware is enabled @@ -1202,7 +1220,7 @@ nm_client_wireless_hardware_get_enabled nm_client_wwan_get_enabled (NMClient *client); Determines whether WWAN is enabled. -Parameters +Parameters @@ -1217,7 +1235,7 @@ nm_client_wwan_get_enabled ( -Returns +Returns TRUE if WWAN is enabled @@ -1229,7 +1247,7 @@ nm_client_wwan_set_enabled (gboolean enabled); Enables or disables WWAN devices. -Parameters +Parameters @@ -1258,7 +1276,7 @@ nm_client_wwan_set_enabled (NMClient *client); Determines whether the WWAN hardware is enabled. -Parameters +Parameters @@ -1273,7 +1291,7 @@ nm_client_wwan_hardware_get_enabled ( -Returns +Returns TRUE if the WWAN hardware is enabled @@ -1284,7 +1302,7 @@ nm_client_wwan_hardware_get_enabled (NMClient *client); Determines whether WiMAX is enabled. -Parameters +Parameters @@ -1299,7 +1317,7 @@ nm_client_wimax_get_enabled ( -Returns +Returns TRUE if WiMAX is enabled @@ -1311,7 +1329,7 @@ nm_client_wimax_set_enabled (gboolean enabled); Enables or disables WiMAX devices. -Parameters +Parameters @@ -1340,7 +1358,7 @@ nm_client_wimax_set_enabled (NMClient *client); Determines whether the WiMAX hardware is enabled. -Parameters +Parameters @@ -1355,7 +1373,7 @@ nm_client_wimax_hardware_get_enabled ( -Returns +Returns TRUE if the WiMAX hardware is enabled @@ -1369,7 +1387,7 @@ nm_client_get_logging (GError **error); Gets NetworkManager current logging level and domains. -Parameters +Parameters @@ -1402,7 +1420,7 @@ a list of domains separated by ",". -Returns +Returns TRUE on success, FALSE otherwise @@ -1416,7 +1434,7 @@ nm_client_set_logging (GError **error); Sets NetworkManager logging level and/or domains. -Parameters +Parameters @@ -1449,7 +1467,7 @@ domains separated by ",". (NULL or an empty string -Returns +Returns TRUE on success, FALSE otherwise @@ -1462,7 +1480,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 @@ -1484,7 +1502,7 @@ client can or cannot perform the action the permission represents -Returns +Returns the permission's result, one of NMClientPermissionResult @@ -1498,7 +1516,7 @@ nm_client_get_connectivity (nm_client_check_connectivity_async(), which re-check the connectivity state first before returning any information. -Parameters +Parameters @@ -1513,7 +1531,7 @@ connectivity state first before returning any information. -Returns +Returns the current connectivity state @@ -1530,7 +1548,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 @@ -1557,7 +1575,7 @@ if you do not want to block. -Returns +Returns the (new) current connectivity state @@ -1575,7 +1593,7 @@ nm_client_check_connectivity_async (nm_client_check_connectivity(), which blocks. -Parameters +Parameters @@ -1618,7 +1636,7 @@ nm_client_check_connectivity_finish (Retrieves the result of an nm_client_check_connectivity_async() call. -Parameters +Parameters @@ -1645,7 +1663,7 @@ call. -Returns +Returns the (new) current connectivity state @@ -1660,7 +1678,7 @@ nm_client_save_hostname ( -Parameters +Parameters @@ -1693,7 +1711,7 @@ clear any existing persistent hostname. -Returns +Returns TRUE if the request was successful, FALSE if it failed @@ -1709,7 +1727,7 @@ nm_client_save_hostname_async (Requests that the machine's persistent hostname be set to the specified value or cleared. -Parameters +Parameters @@ -1757,7 +1775,7 @@ nm_client_save_hostname_finish (GError **error); Gets the result of an nm_client_save_hostname_async() call. -Parameters +Parameters @@ -1784,7 +1802,7 @@ nm_client_save_hostname_finish ( -Returns +Returns TRUE if the request was successful, FALSE if it failed @@ -1798,7 +1816,7 @@ nm_client_get_devices (nm_device_ethernet_get_hw_address(). -Parameters +Parameters @@ -1813,9 +1831,9 @@ methods such as -Returns +Returns a GPtrArray -containing all the NMDevices. The returned array is owned by the +containing all the NMDevices. The returned array is owned by the NMClient object and should not be modified. [transfer none][element-type NMDevice] @@ -1834,7 +1852,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 @@ -1849,9 +1867,9 @@ use device-specific methods such as -Returns +Returns a GPtrArray -containing all the NMDevices. The returned array is owned by the +containing all the NMDevices. The returned array is owned by the NMClient object and should not be modified. [transfer none][element-type NMDevice] @@ -1865,7 +1883,7 @@ nm_client_get_device_by_path (const char *object_path); Gets a NMDevice from a NMClient. -Parameters +Parameters @@ -1887,7 +1905,7 @@ nm_client_get_device_by_path ( -Returns +Returns the NMDevice for the given object_path or NULL if none is found. [transfer none] @@ -1901,7 +1919,7 @@ nm_client_get_device_by_iface (const char *iface); Gets a NMDevice from a NMClient. -Parameters +Parameters @@ -1923,7 +1941,7 @@ nm_client_get_device_by_iface ( -Returns +Returns the NMDevice for the given iface or NULL if none is found. [transfer none] @@ -1936,7 +1954,7 @@ or NULL if none is found. nm_client_get_active_connections (NMClient *client); Gets the active connections. -Parameters +Parameters @@ -1951,9 +1969,9 @@ nm_client_get_active_connections ( -Returns +Returns a GPtrArray -containing all the active NMActiveConnections. +containing all the active NMActiveConnections. The returned array is owned by the client and should not be modified. [transfer none][element-type NMActiveConnection] @@ -1973,7 +1991,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 @@ -1988,7 +2006,7 @@ non-NetworkManager-recognized device, this will return NUL -Returns +Returns the appropriate NMActiveConnection, if any. [transfer none] @@ -2003,7 +2021,7 @@ nm_client_get_activating_connection (“primary-connection” upon successful activation. -Parameters +Parameters @@ -2018,7 +2036,7 @@ currently-activating connection that is expected to become the new -Returns +Returns the appropriate NMActiveConnection, if any. [transfer none] @@ -2054,7 +2072,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 @@ -2118,7 +2136,7 @@ nm_client_activate_connection_finish (GError **error); Gets the result of a call to nm_client_activate_connection_async(). -Parameters +Parameters @@ -2145,7 +2163,7 @@ nm_client_activate_connection_finish ( -Returns +Returns the new NMActiveConnection on success, NULL on failure, in which case error will be set. @@ -2174,7 +2192,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 @@ -2245,7 +2263,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 @@ -2272,7 +2290,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. @@ -2289,7 +2307,7 @@ nm_client_deactivate_connection (GError **error); Deactivates an active NMActiveConnection. -Parameters +Parameters @@ -2321,7 +2339,7 @@ nm_client_deactivate_connection ( -Returns +Returns success or failure @@ -2336,7 +2354,7 @@ nm_client_deactivate_connection_async (gpointer user_data); Asynchronously deactivates an active NMActiveConnection. -Parameters +Parameters @@ -2384,7 +2402,7 @@ nm_client_deactivate_connection_finish GError **error); Gets the result of a call to nm_client_deactivate_connection_async(). -Parameters +Parameters @@ -2411,7 +2429,7 @@ nm_client_deactivate_connection_finish -Returns +Returns success or failure @@ -2421,7 +2439,7 @@ nm_client_deactivate_connection_finish const GPtrArray * nm_client_get_connections (NMClient *client); -Parameters +Parameters @@ -2436,7 +2454,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. @@ -2454,7 +2472,7 @@ nm_client_get_connection_by_id (Returns the first matching NMRemoteConnection matching a given id . -Parameters +Parameters @@ -2476,7 +2494,7 @@ 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 @@ -2493,7 +2511,7 @@ nm_client_get_connection_by_path (Returns the NMRemoteConnection representing the connection at path . -Parameters +Parameters @@ -2515,7 +2533,7 @@ 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 @@ -2532,7 +2550,7 @@ nm_client_get_connection_by_uuid (Returns the NMRemoteConnection identified by uuid . -Parameters +Parameters @@ -2554,7 +2572,7 @@ 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 @@ -2590,7 +2608,7 @@ identical settings to connection as NetworkManager may perform automatic completion and/or normalization of connection properties. -Parameters +Parameters @@ -2643,7 +2661,7 @@ nm_client_add_connection_finish (GError **error); Gets the result of a call to nm_client_add_connection_async(). -Parameters +Parameters @@ -2670,7 +2688,7 @@ nm_client_add_connection_finish ( -Returns +Returns the new NMRemoteConnection on success, NULL on failure, in which case error will be set. @@ -2699,7 +2717,7 @@ then failures will be set to a NULL-terminated array of the filenames that failed to load. -Parameters +Parameters @@ -2714,8 +2732,8 @@ filenames that failed to load. - - + + @@ -2737,7 +2755,7 @@ filenames that failed to load. filenames NULL-terminated array of filenames to load NULL-terminated array of filenames to load. [array zero-terminated=1] failures -Returns +Returns TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied). @@ -2756,7 +2774,7 @@ nm_client_load_connections_async ( See nm_client_load_connections() for more details. -Parameters +Parameters @@ -2771,8 +2789,8 @@ given files, adding or updating the connections described within. - - + + @@ -2805,7 +2823,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 filenames NULL-terminated array of filenames to load NULL-terminated array of filenames to load. [array zero-terminated=1] cancellable @@ -2820,9 +2838,9 @@ nm_client_load_connections_finish ( - - + + @@ -2838,7 +2856,7 @@ filenames that failed to load. failures on return, a NULL-terminated array of -filenames that failed to load. [out][transfer full] on return, a +NULL-terminated array of filenames that failed to load. [out][transfer full][array zero-terminated=1] result -Returns +Returns TRUE if NetworkManager at least tried to load filenames , FALSE if an error occurred (eg, permission denied). @@ -2855,7 +2873,7 @@ nm_client_reload_connections ( -Parameters +Parameters @@ -2882,7 +2900,7 @@ the in-memory state matches the on-disk state. -Returns +Returns TRUE on success, FALSE on failure @@ -2898,7 +2916,7 @@ nm_client_reload_connections_async ( -Parameters +Parameters @@ -2940,7 +2958,7 @@ nm_client_reload_connections_finish (GError **error); Gets the result of an nm_client_reload_connections_async() call. -Parameters +Parameters @@ -2967,7 +2985,7 @@ nm_client_reload_connections_finish ( -Returns +Returns TRUE on success, FALSE on failure @@ -3143,11 +3161,23 @@ nm_client_reload_connections_finish ( +NM_CLIENT_ACTIVE_CONNECTION_ADDED +#define NM_CLIENT_ACTIVE_CONNECTION_ADDED "active-connection-added" + + + + +NM_CLIENT_ACTIVE_CONNECTION_REMOVED +#define NM_CLIENT_ACTIVE_CONNECTION_REMOVED "active-connection-removed" + + + + enum NMClientPermission NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user. -Members +Members @@ -3266,6 +3296,21 @@ clients can obtain to perform certain tasks on behalf of the current user. + + + + + + + + + + NM_CLIENT_PERMISSION_CHECKPOINT_ROLLBACK +permission to create checkpoints. + NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS +controls whether device + statistics can be globally enabled or disabled + NM_CLIENT_PERMISSION_LAST a reserved boundary value @@ -3282,7 +3327,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 @@ -3331,7 +3376,7 @@ the user requires to obtain a given NMManagerError, NMSettingsError, NMAgentManagerError, and NMConnectionError. -Members +Members @@ -3559,6 +3604,80 @@ see Signal Details +The “active-connection-added” signal +void +user_function (NMClient *client, + NMActiveConnection *active_connection, + gpointer user_data) +Notifies that a NMActiveConnection has been added. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the settings object that received the signal active_connection the new active connection user_data user data set when the signal handler was connected. + +Flags: Run First + + + +The “active-connection-removed” signal +void +user_function (NMClient *client, + NMActiveConnection *active_connection, + gpointer user_data) +Notifies that a NMActiveConnection has been removed. + +Parameters + +++++ + + + + + + + + + + + + + + + + + + client the settings object that received the signal active_connection the removed active connection user_data user data set when the signal handler was connected. + +Flags: Run First + + + The “any-device-added” signal void user_function (NMClient *client, @@ -3567,7 +3686,7 @@ user_function (Notifies that a NMDevice is added. This signal is emitted for both regular devices and placeholder devices. -Parameters +Parameters @@ -3605,7 +3724,7 @@ user_function (Notifies that a NMDevice is removed. This signal is emitted for both regular devices and placeholder devices. -Parameters +Parameters @@ -3642,7 +3761,7 @@ user_function (gpointer user_data) Notifies that a NMConnection has been added. -Parameters +Parameters @@ -3679,7 +3798,7 @@ user_function (gpointer user_data) Notifies that a NMConnection has been removed. -Parameters +Parameters @@ -3717,7 +3836,7 @@ user_function (Notifies that a NMDevice is added. This signal is not emitted for placeholder devices. -Parameters +Parameters @@ -3755,7 +3874,7 @@ user_function (Notifies that a NMDevice is removed. This signal is not emitted for placeholder devices. -Parameters +Parameters @@ -3793,7 +3912,7 @@ user_function (gpointer user_data) Notifies that a permission has changed -Parameters +Parameters @@ -3829,6 +3948,6 @@ user_function ( - Generated by GTK-Doc V1.24 +Generated by GTK-Doc V1.25 \ No newline at end of file -- cgit 1.3.0-6-gf8a5

filenames	`NULL`-terminated array of filenames to load		`NULL`-terminated array of filenames to load.	[array zero-terminated=1]
failures

failures	on return, a `NULL`-terminated array of -filenames that failed to load.	[out][transfer full]	on return, a +`NULL`-terminated array of filenames that failed to load.	[out][transfer full][array zero-terminated=1]
result