From 270c4830551c9810ad4e83f9a1db2b1cb946208c Mon Sep 17 00:00:00 2001
From: Michael Biebl
NMClient implements
- GInitable and GAsyncInitable.
-GQuark
+GQuark
nm_client_error_quark ()
@@ -92,7 +92,7 @@
-gboolean
+gboolean
nm_client_get_startup ()
@@ -100,7 +100,7 @@
-gboolean
+gboolean
nm_client_get_nm_running ()
@@ -108,7 +108,7 @@
-gboolean
+gboolean
nm_client_networking_get_enabled ()
@@ -116,7 +116,7 @@
-gboolean
+gboolean
nm_client_networking_set_enabled ()
@@ -124,7 +124,7 @@
-gboolean
+gboolean
nm_client_wireless_get_enabled ()
@@ -140,7 +140,7 @@
-gboolean
+gboolean
nm_client_wireless_hardware_get_enabled ()
@@ -148,7 +148,7 @@
-gboolean
+gboolean
nm_client_wwan_get_enabled ()
@@ -164,7 +164,7 @@
-gboolean
+gboolean
nm_client_wwan_hardware_get_enabled ()
@@ -172,7 +172,7 @@
-gboolean
+gboolean
nm_client_wimax_get_enabled ()
@@ -188,7 +188,7 @@
-gboolean
+gboolean
nm_client_wimax_hardware_get_enabled ()
@@ -196,7 +196,7 @@
-gboolean
+gboolean
nm_client_get_logging ()
@@ -204,7 +204,7 @@
-gboolean
+gboolean
nm_client_set_logging ()
@@ -252,7 +252,7 @@
-gboolean
+gboolean
nm_client_save_hostname ()
@@ -268,21 +268,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 ()
@@ -305,7 +305,7 @@
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_active_connections ()
@@ -361,7 +361,7 @@
-gboolean
+gboolean
nm_client_deactivate_connection ()
@@ -377,14 +377,14 @@
-gboolean
+gboolean
nm_client_deactivate_connection_finish ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_connections ()
@@ -432,7 +432,7 @@
-gboolean
+gboolean
nm_client_load_connections ()
@@ -448,7 +448,7 @@
-gboolean
+gboolean
nm_client_load_connections_finish ()
@@ -456,7 +456,7 @@
-gboolean
+gboolean
nm_client_reload_connections ()
@@ -472,7 +472,7 @@
-gboolean
+gboolean
nm_client_reload_connections_finish ()
@@ -498,24 +498,24 @@
-GPtrArray *
+GPtrArray *
active-connections
Read
-GPtrArray *
+GPtrArray *
all-devices
Read
-
gboolean
+gboolean
can-modify
Read
@@ -526,28 +526,28 @@
-GPtrArray *
+GPtrArray *
connections
Read
-GPtrArray *
+GPtrArray *
devices
Read
-gchar *
+gchar *
hostname
Read
-
guint
+guint
metered
Read
-
gboolean
+gboolean
networking-enabled
Read / Write
-
@@ -558,7 +558,7 @@
gboolean
+gboolean
nm-running
Read
Read
-
@@ -569,37 +569,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
-
@@ -618,47 +618,47 @@
gboolean
+gboolean
wwan-hardware-enabled
Read
void
active-connection-added
-Run First
+Run First
void
active-connection-removed
-Run First
+Run First
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
@@ -816,11 +816,11 @@
void
permission-changed
-Run First
+Run First
Object Hierarchy
- GEnum
+
GEnum
├── NMClientError
├── NMClientPermission
╰── NMClientPermissionResult
- GObject
+ GObject
╰── NMClient
Implemented Interfaces
GQuark +GQuark nm_client_error_quark (void);Registers an error quark for NMClient if necessary.
@@ -849,8 +849,8 @@ nm_client_error_quark (voidnm_client_new ()
NMClient * -nm_client_new (+nm_client_new (GCancellable *cancellable, -GError **error);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 @@ -866,12 +866,12 @@ that.- cancellable
+ a GCancellable, or
NULLa GCancellable, or
NULL@@ -886,9 +886,9 @@ that. - error
+ location for a GError, or
NULLnm_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);Creates a new NMClient and begins asynchronously initializing it.
callbackwill be called when it is done; use @@ -905,7 +905,7 @@ the callback can be invoked with two first parameters as NULL.- cancellable
+ a GCancellable, or
NULLa GCancellable, or
NULL@@ -927,8 +927,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);Gets the result of an
nm_client_new_async()call.
@@ -980,7 +980,7 @@ nm_client_get_version (Returns
-string with the version (or
+NULLif NetworkManager is not running)string with the version (or
NULLif NetworkManager is not running)
@@ -1012,7 +1012,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.
@@ -1039,7 +1039,7 @@ connections at startup.
nm_client_get_nm_running ()
-gboolean +gboolean nm_client_get_nm_running (NMClient *client);Determines whether the daemon is running.
@@ -1059,13 +1059,13 @@ nm_client_get_nm_running (Returns
-+
TRUEif the daemon is running
TRUEif the daemon is running
nm_client_networking_get_enabled ()
-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.
@@ -1114,12 +1114,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@@ -1127,13 +1127,13 @@ all controlled interfaces are available for activation. - error
+ return location for a GError, or
NULL.[allow-none]
nm_client_wireless_get_enabled ()
-gboolean +gboolean nm_client_wireless_get_enabled (NMClient *client);Determines whether the wireless is enabled.
@@ -1161,7 +1161,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
@@ -1179,7 +1179,7 @@ nm_client_wireless_set_enabled (@@ -1189,7 +1189,7 @@ nm_client_wireless_set_enabled ( - enabled
+
TRUEto enable wireless
TRUEto enable wireless
nm_client_wwan_get_enabled ()
-gboolean +gboolean nm_client_wwan_get_enabled (NMClient *client);Determines whether WWAN is enabled.
@@ -1236,7 +1236,7 @@ nm_client_wwan_get_enabled (Returns
-+
TRUEif WWAN is enabled
TRUEif WWAN is enabled
@@ -1244,7 +1244,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
@@ -1262,7 +1262,7 @@ nm_client_wwan_set_enabled (enabled
-+
TRUEto enable WWAN
TRUEto enable WWAN@@ -1272,7 +1272,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.
@@ -1318,7 +1318,7 @@ nm_client_wimax_get_enabled (Returns
-+
TRUEif WiMAX is enabled
TRUEif WiMAX is enabled
@@ -1326,7 +1326,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
@@ -1344,7 +1344,7 @@ nm_client_wimax_set_enabled (enabled
-+
TRUEto enable WiMAX
TRUEto enable WiMAX@@ -1354,7 +1354,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.
@@ -1374,17 +1374,17 @@ nm_client_wimax_hardware_get_enabled (Returns
-+
TRUEif the WiMAX hardware is enabled
TRUEif 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
@@ -1449,18 +1449,18 @@ nm_client_set_logging (level
-+ logging level to set (
NULLor an empty string for no change).logging level to set (
NULLor an empty string for no change).[allow-none] domains
+domains separated by ",". ( logging domains to set. The string should be a list of log -domains separated by ",". (
NULLor an empty string for no change).NULLor an empty string for no change).[allow-none] @@ -1468,7 +1468,7 @@ domains separated by ",". ( - error
+ return location for a GError, or
NULL.[allow-none] NULLor an empty string
@@ -1540,8 +1540,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
@@ -1563,12 +1563,12 @@ if you do not want to block.nm_client_get_connectivity(), which returns the most recent known state without re-checking.- cancellable
+ a GCancellable
@@ -1584,9 +1584,9 @@ if you do not want to block. - error
+ return location for a GError
return location for a GError
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
callbackwhen complete. Contrastnm_client_get_connectivity(), @@ -1608,7 +1608,7 @@ re-checking, andcancellable
-+ a GCancellable
@@ -1631,8 +1631,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.@@ -1651,12 +1651,12 @@ call.- result
+ the GAsyncResult
the GAsyncResult
@@ -1670,11 +1670,11 @@ call. - error
+ return location for a GError
return location for a GError
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.
@@ -1693,18 +1693,18 @@ or cleared.- hostname
the new persistent hostname to set, or
NULLto +the new persistent hostname to set, or
NULLto clear any existing persistent hostname.[allow-none] - cancellable
+ a GCancellable, or
NULLa GCancellable, or
NULL@@ -1712,7 +1712,7 @@ clear any existing persistent hostname. - error
+ return location for GError
return location for GError
@@ -1721,9 +1721,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.
@@ -1742,13 +1742,13 @@ or cleared.- hostname
the new persistent hostname to set, or
NULLto +the new persistent hostname to set, or
NULLto clear any existing persistent hostname.[allow-none] - cancellable
+ a GCancellable, or
NULLa GCancellable, or
NULL@@ -1769,10 +1769,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
@@ -1790,12 +1790,12 @@ nm_client_save_hostname_finish (- result
+ the result passed to the GAsyncReadyCallback
the result passed to the GAsyncReadyCallback
@@ -1803,13 +1803,13 @@ nm_client_save_hostname_finish ( - error
+ return location for GError
return location for GError
@@ -1943,14 +1943,14 @@ nm_client_get_device_by_iface (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 theNM_IS_DEVICE_XXXXfunctions to determine what kind of @@ -1832,7 +1832,7 @@ methods such asReturns
-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]
@@ -1841,7 +1841,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 @@ -1868,7 +1868,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]
@@ -1907,7 +1907,7 @@ nm_client_get_device_by_path (Returns
the NMDevice for the given
+orobject_path-orNULLif none is found.NULLif none is found.[transfer none]
Returns
the NMDevice for the given
+oriface-orNULLif none is found.NULLif 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.
@@ -1970,7 +1970,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]
@@ -1989,7 +1989,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
+non-NetworkManager-recognized device, this will returnNULL.NULL.-Parameters
Flags: Run First
+Flags: Run First
@@ -3645,7 +3645,7 @@ user_function (void user_function (NMClient *client, NMActiveConnection *active_connection, - gpointer user_data) + gpointer user_data)-Notifies that a NMActiveConnection has been removed.
Flags: Run First
+Flags: Run First
-The
“any-device-added”signalvoid user_function (NMClient *client, - GObject *device, - gpointer user_data)+ GObject *device, + gpointer user_data)Notifies that a NMDevice is added. This signal is emitted for both regular devices and placeholder devices.
@@ -3712,15 +3712,15 @@ regular devices and placeholder devices.Flags: Run First
+Flags: Run First
-The
“any-device-removed”signalvoid user_function (NMClient *client, - GObject *device, - gpointer user_data)+ GObject *device, + gpointer user_data)Notifies that a NMDevice is removed. This signal is emitted for both regular devices and placeholder devices.
@@ -3750,7 +3750,7 @@ regular devices and placeholder devices.Flags: Run First
+Flags: Run First
@@ -3758,7 +3758,7 @@ regular devices and placeholder devices.-void user_function (NMClient *client, NMRemoteConnection *connection, - gpointer user_data)+ gpointer user_data)Notifies that a NMConnection has been added.
Flags: Run First
+Flags: Run First
@@ -3795,7 +3795,7 @@ user_function (void user_function (NMClient *client, NMRemoteConnection *connection, - gpointer user_data) + gpointer user_data)-Notifies that a NMConnection has been removed.
Flags: Run First
+Flags: Run First
-The
“device-added”signalvoid 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.
@@ -3862,15 +3862,15 @@ placeholder devices.Flags: Run First
+Flags: Run First
-The
“device-removed”signalvoid 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.
@@ -3900,16 +3900,16 @@ placeholder devices.Flags: Run First
+Flags: Run First
-The
“permission-changed”signalvoid 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