From d9c99a29a0d3384c9c3d2adce430f5cb1134ab6a Mon Sep 17 00:00:00 2001
From: Michael Biebl Registers an error quark for NMClient if necessary. Creates a new NMClient. Note that this will do blocking D-Bus calls to initialize the
client. You can use cancellable a GCancellable, or a GCancellable, or error location for a GError, or Creates a new NMClient and begins asynchronously initializing it.
cancellable a GCancellable, or a GCancellable, or Gets the result of an error location for a GError, or a new NMClient, or a new NMClient, or string with the version (or string with the version (or Tests whether the daemon is still in the process of activating
connections at startup.
-GQuark
+GQuark
nm_client_error_quark ()
@@ -91,7 +91,7 @@
-gboolean
+gboolean
nm_client_get_startup ()
@@ -99,7 +99,7 @@
-gboolean
+gboolean
nm_client_get_nm_running ()
@@ -107,7 +107,7 @@
-gboolean
+gboolean
nm_client_networking_get_enabled ()
@@ -115,7 +115,7 @@
-gboolean
+gboolean
nm_client_networking_set_enabled ()
@@ -123,7 +123,7 @@
-gboolean
+gboolean
nm_client_wireless_get_enabled ()
@@ -139,7 +139,7 @@
-gboolean
+gboolean
nm_client_wireless_hardware_get_enabled ()
@@ -147,7 +147,7 @@
-gboolean
+gboolean
nm_client_wwan_get_enabled ()
@@ -163,7 +163,7 @@
-gboolean
+gboolean
nm_client_wwan_hardware_get_enabled ()
@@ -171,7 +171,7 @@
-gboolean
+gboolean
nm_client_wimax_get_enabled ()
@@ -187,7 +187,7 @@
-gboolean
+gboolean
nm_client_wimax_hardware_get_enabled ()
@@ -195,7 +195,7 @@
-gboolean
+gboolean
nm_client_get_logging ()
@@ -203,7 +203,7 @@
-gboolean
+gboolean
nm_client_set_logging ()
@@ -251,7 +251,7 @@
-gboolean
+gboolean
nm_client_save_hostname ()
@@ -267,21 +267,21 @@
-gboolean
+gboolean
nm_client_save_hostname_finish ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_devices ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_all_devices ()
@@ -304,7 +304,7 @@
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_active_connections ()
@@ -360,7 +360,7 @@
-gboolean
+gboolean
nm_client_deactivate_connection ()
@@ -376,14 +376,14 @@
-gboolean
+gboolean
nm_client_deactivate_connection_finish ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_connections ()
@@ -431,7 +431,7 @@
-gboolean
+gboolean
nm_client_load_connections ()
@@ -447,7 +447,7 @@
-gboolean
+gboolean
nm_client_load_connections_finish ()
@@ -455,7 +455,7 @@
-gboolean
+gboolean
nm_client_reload_connections ()
@@ -471,7 +471,7 @@
-gboolean
+gboolean
nm_client_reload_connections_finish ()
@@ -497,24 +497,24 @@
-GPtrArray *
+GPtrArray *
active-connections
Read
-GPtrArray *
+GPtrArray *
all-devices
Read
-
gboolean
+gboolean
can-modify
Read
@@ -525,28 +525,28 @@
-GPtrArray *
+GPtrArray *
connections
Read
-GPtrArray *
+GPtrArray *
devices
Read
-gchar *
+gchar *
hostname
Read
-
guint
+guint
metered
Read
-
gboolean
+gboolean
networking-enabled
Read / Write
-
@@ -557,7 +557,7 @@
gboolean
+gboolean
nm-running
Read
Read
-
@@ -568,37 +568,37 @@
gboolean
+gboolean
startup
Read
-gchar *
+gchar *
version
Read
-
gboolean
+gboolean
wimax-enabled
Read / Write
-
gboolean
+gboolean
wimax-hardware-enabled
Read
-
gboolean
+gboolean
wireless-enabled
Read / Write
-
gboolean
+gboolean
wireless-hardware-enabled
Read
-
gboolean
+gboolean
wwan-enabled
Read / Write
-
@@ -617,37 +617,37 @@
gboolean
+gboolean
wwan-hardware-enabled
Read
void
any-device-added
-Run First
+Run First
void
any-device-removed
-Run First
+Run First
void
connection-added
-Run First
+Run First
void
connection-removed
-Run First
+Run First
void
device-added
-Run First
+Run First
void
device-removed
-Run First
+Run First
@@ -793,11 +793,11 @@
void
permission-changed
-Run First
+Run First
Object Hierarchy
- GEnum
+
GEnum
├── NMClientError
├── NMClientPermission
╰── NMClientPermissionResult
- GObject
+ GObject
╰── NMClient
Functions
nm_client_error_quark ()
-GQuark
+
GQuark
nm_client_error_quark (
void);void
nm_client_new ()
NMClient *
-nm_client_new (
+nm_client_new (GCancellable *cancellable,
- GError **error);GCancellable *cancellable,
+ GError **error);
nm_client_new_async() if you want to avoid
@@ -837,12 +837,12 @@ that.
-
+NULLNULL
@@ -857,9 +857,9 @@ that.
-
+ NULL
nm_client_new_async ()
void
-nm_client_new_async (
+nm_client_new_async (GCancellable *cancellable,
- GAsyncReadyCallback callback,
- gpointer user_data);GCancellable *cancellable,
+ GAsyncReadyCallback callback,
+ gpointer user_data);
callback
will be called when it is done; use
@@ -876,7 +876,7 @@ the callback can be invoked with two first parameters as NULL.
-
+NULLNULL
@@ -898,8 +898,8 @@ the callback can be invoked with two first parameters as NULL.
nm_client_new_finish ()
NMClient *
-nm_client_new_finish (
+nm_client_new_finish (GAsyncResult *result,
- GError **error);GAsyncResult *result,
+ GError **error);
nm_client_new_async() call.
@@ -925,7 +925,7 @@ nm_client_new_finish (
-
+ NULL
Returns
-NULL on errorNULL on error
@@ -951,7 +951,7 @@ nm_client_get_version (
Returns
-NULL if NetworkManager is not running)NULL if NetworkManager is not running)
@@ -983,7 +983,7 @@ nm_client_get_state (
nm_client_get_startup ()
-gboolean
+
gboolean
nm_client_get_startup (
NMClient *client);
gboolean +gboolean nm_client_get_nm_running (NMClient *client);Determines whether the daemon is running.
@@ -1030,13 +1030,13 @@ nm_client_get_nm_running (Returns
-+
TRUEif the daemon is running
TRUEif the daemon is running
gboolean +gboolean nm_client_networking_get_enabled (NMClient *client);Whether networking is enabled or 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.
@@ -1085,12 +1085,12 @@ all controlled interfaces are available for activation.- enabled
+
TRUEto set networking enabled,FALSEto set networking disabled
TRUEto set networking enabled,FALSEto set networking disabled@@ -1098,13 +1098,13 @@ all controlled interfaces are available for activation. - error
+ return location for a GError, or
NULL.[allow-none]
gboolean +gboolean nm_client_wireless_get_enabled (NMClient *client);Determines whether the wireless is enabled.
@@ -1132,7 +1132,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.
enabled
-TRUE to enable wireless
+TRUE to enable wireless
@@ -1160,7 +1160,7 @@ nm_client_wireless_set_enabled (
gboolean +gboolean nm_client_wwan_get_enabled (NMClient *client);Determines whether WWAN is enabled.
@@ -1207,7 +1207,7 @@ nm_client_wwan_get_enabled (Returns
-+
TRUEif WWAN is enabled
TRUEif WWAN is enabled
nm_client_wwan_set_enabled ()
void
nm_client_wwan_set_enabled (NMClient *client,
- gboolean enabled);
+ gboolean enabled);
Enables or disables WWAN devices.
Parameters
@@ -1233,7 +1233,7 @@ nm_client_wwan_set_enabled (enabled
-TRUE to enable WWAN
+TRUE to enable WWAN
@@ -1243,7 +1243,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.
nm_client_wimax_get_enabled ()
-gboolean
+gboolean
nm_client_wimax_get_enabled (NMClient *client);
Determines whether WiMAX is enabled.
@@ -1289,7 +1289,7 @@ nm_client_wimax_get_enabled (
Returns
- TRUE if WiMAX is enabled
+ TRUE if WiMAX is enabled
@@ -1297,7 +1297,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
@@ -1315,7 +1315,7 @@ nm_client_wimax_set_enabled (enabled
-TRUE to enable WiMAX
+TRUE to enable WiMAX
@@ -1325,7 +1325,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.
@@ -1345,17 +1345,17 @@ nm_client_wimax_hardware_get_enabled (
Returns
- TRUE if the WiMAX hardware is enabled
+ TRUE if the WiMAX hardware is enabled
nm_client_get_logging ()
-gboolean
+gboolean
nm_client_get_logging (NMClient *client,
char **level,
char **domains,
- GError **error);
+ GError **error);
Gets NetworkManager current logging level and domains.
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
@@ -1420,18 +1420,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.
[allow-none]
@@ -1439,7 +1439,7 @@ domains separated by ",". (
Returns
- TRUE on success, FALSE otherwise
+ TRUE on success, FALSE otherwise
@@ -1511,8 +1511,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.
@@ -1534,12 +1534,12 @@ if you do not want to block.
cancellable
-
+a GCancellable
error
-return location for a GError
+return location for a GError
@@ -1555,9 +1555,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(),
@@ -1579,7 +1579,7 @@ re-checking, and cancellable
-
+a GCancellable
@@ -1602,8 +1602,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.
@@ -1622,12 +1622,12 @@ call.
result
-the GAsyncResult
+the GAsyncResult
error
-return location for a GError
+return location for a GError
@@ -1641,11 +1641,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.
@@ -1664,18 +1664,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
@@ -1683,7 +1683,7 @@ clear any existing persistent hostname.
@@ -1692,9 +1692,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.
@@ -1713,13 +1713,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
@@ -1740,10 +1740,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
@@ -1761,12 +1761,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
@@ -1774,13 +1774,13 @@ nm_client_save_hostname_finish (
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
@@ -1803,7 +1803,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]
@@ -1812,7 +1812,7 @@ containing all the NMDevices
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
@@ -1839,7 +1839,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]
@@ -1878,7 +1878,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]
@@ -1914,14 +1914,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.
@@ -1941,7 +1941,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]
@@ -1960,7 +1960,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
-Flags: Run First
+Flags: Run First
@@ -3600,8 +3608,8 @@ regular devices and placeholder devices.
void
user_function (NMClient *client,
NMRemoteConnection *connection,
- gpointer user_data)
-Notifies that a NMConnection has been added.
+ gpointer user_data)
+Notifies that a NMConnection has been added.
-Flags: Run First
+Flags: Run First
@@ -3637,8 +3645,8 @@ user_function (void
user_function (NMClient *client,
NMRemoteConnection *connection,
- gpointer user_data)
-Notifies that a NMConnection has been removed.
+ gpointer user_data)
+Notifies that a NMConnection has been removed.
-Flags: Run First
+Flags: Run First
The “device-added” signal
void
user_function (NMClient *client,
- GObject *device,
- gpointer user_data)
+ GObject *device,
+ gpointer user_data)
Notifies that a NMDevice is added. This signal is not emitted for
placeholder devices.
@@ -3704,15 +3712,15 @@ placeholder devices.
-Flags: Run First
+Flags: Run First
The “device-removed” signal
void
user_function (NMClient *client,
- GObject *device,
- gpointer user_data)
+ GObject *device,
+ gpointer user_data)
Notifies that a NMDevice is removed. This signal is not emitted for
placeholder devices.
@@ -3742,16 +3750,16 @@ placeholder devices.
-Flags: Run First
+Flags: Run First
The “permission-changed” signal
void
user_function (NMClient *client,
- guint permission,
- guint result,
- gpointer user_data)
+ guint permission,
+ guint result,
+ gpointer user_data)
Notifies that a permission has changed
-Flags: Run First
+Flags: Run First
--
cgit 1.3.0-6-gf8a5