From afcd268ea7b1149fbfb66bce4eca659b675da0a2 Mon Sep 17 00:00:00 2001
From: Michael Biebl
NMClient implements
- GInitable and GAsyncInitable.
-GQuark
+GQuark
nm_client_error_quark ()
@@ -90,7 +90,7 @@
-gboolean
+gboolean
nm_dns_entry_get_vpn ()
@@ -137,7 +137,7 @@
-gboolean
+gboolean
nm_client_get_startup ()
@@ -145,7 +145,7 @@
-gboolean
+gboolean
nm_client_get_nm_running ()
@@ -153,7 +153,7 @@
-gboolean
+gboolean
nm_client_networking_get_enabled ()
@@ -161,7 +161,7 @@
-gboolean
+gboolean
nm_client_networking_set_enabled ()
@@ -169,7 +169,7 @@
-gboolean
+gboolean
nm_client_wireless_get_enabled ()
@@ -185,7 +185,7 @@
-gboolean
+gboolean
nm_client_wireless_hardware_get_enabled ()
@@ -193,7 +193,7 @@
-gboolean
+gboolean
nm_client_wwan_get_enabled ()
@@ -209,7 +209,7 @@
-gboolean
+gboolean
nm_client_wwan_hardware_get_enabled ()
@@ -217,7 +217,7 @@
-gboolean
+gboolean
nm_client_wimax_get_enabled ()
@@ -233,7 +233,7 @@
-gboolean
+gboolean
nm_client_wimax_hardware_get_enabled ()
@@ -241,7 +241,7 @@
-gboolean
+gboolean
nm_client_connectivity_check_get_available ()
@@ -249,7 +249,7 @@
-gboolean
+gboolean
nm_client_connectivity_check_get_enabled ()
@@ -265,7 +265,7 @@
-gboolean
+gboolean
nm_client_get_logging ()
@@ -273,7 +273,7 @@
-gboolean
+gboolean
nm_client_set_logging ()
@@ -321,7 +321,7 @@
-gboolean
+gboolean
nm_client_save_hostname ()
@@ -337,21 +337,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 ()
@@ -374,7 +374,7 @@
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_active_connections ()
@@ -430,7 +430,7 @@
-gboolean
+gboolean
nm_client_deactivate_connection ()
@@ -446,14 +446,14 @@
-gboolean
+gboolean
nm_client_deactivate_connection_finish ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_connections ()
@@ -501,7 +501,7 @@
-gboolean
+gboolean
nm_client_load_connections ()
@@ -517,7 +517,7 @@
-gboolean
+gboolean
nm_client_load_connections_finish ()
@@ -525,7 +525,7 @@
-gboolean
+gboolean
nm_client_reload_connections ()
@@ -541,7 +541,7 @@
-gboolean
+gboolean
nm_client_reload_connections_finish ()
@@ -562,7 +562,7 @@
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_dns_configuration ()
@@ -588,24 +588,24 @@
-GPtrArray *
+GPtrArray *
active-connections
Read
-GPtrArray *
+GPtrArray *
all-devices
Read
-
gboolean
+gboolean
can-modify
Read
@@ -615,57 +615,57 @@
-GPtrArray *
+GPtrArray *
connections
Read
Read
-
gboolean
+gboolean
connectivity-check-available
Read
-
gboolean
+gboolean
connectivity-check-enabled
Read / Write
-GPtrArray *
+GPtrArray *
devices
Read
-GPtrArray *
+GPtrArray *
dns-configuration
Read
-gchar *
+gchar *
dns-mode
Read
-gchar *
+gchar *
dns-rc-manager
Read
-gchar *
+gchar *
hostname
Read
-
guint
+guint
metered
Read
-
gboolean
+gboolean
networking-enabled
Read / Write
-
@@ -676,7 +676,7 @@
gboolean
+gboolean
nm-running
Read
Read
-
@@ -687,37 +687,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
-
@@ -736,47 +736,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
@@ -954,13 +954,13 @@
void
permission-changed
-Run First
+Run First
Object Hierarchy
- GBoxed
+
GBoxed
╰── NMDnsEntry
- 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.
@@ -1032,7 +1032,7 @@ nm_dns_entry_get_interface (Returns
-the interface name.
+the interface name.
[transfer none]
Since: 1.6
@@ -1060,7 +1060,7 @@ nm_dns_entry_get_nameservers (Returns
-the list of name servers.
+the list of name servers.
[transfer none]
Since: 1.6
@@ -1088,7 +1088,7 @@ nm_dns_entry_get_domains (
Returns
- the list of DNS domains.
+the list of DNS domains.
[transfer none]
Since: 1.6
@@ -1123,7 +1123,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 +1143,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 +1151,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 +1168,12 @@ that.
cancellable
-a GCancellable, or NULL
+a GCancellable, or NULL
error
-
+
@@ -1188,9 +1188,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 +1207,7 @@ the callback can be invoked with two first parameters as NULL.
cancellable
-a GCancellable, or NULL
+a GCancellable, or NULL
@@ -1229,8 +1229,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.
error
-
+
@@ -1256,7 +1256,7 @@ nm_client_new_finish (
Returns
-
+
@@ -1282,7 +1282,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 +1314,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 +1341,7 @@ connections at startup.
nm_client_get_nm_running ()
-gboolean
+gboolean
nm_client_get_nm_running (NMClient *client);
Determines whether 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.
@@ -1416,12 +1416,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
-
+
[allow-none]
@@ -1429,13 +1429,13 @@ all controlled interfaces are available for activation.
nm_client_wireless_get_enabled ()
-gboolean
+gboolean
nm_client_wireless_get_enabled (NMClient *client);
Determines whether the wireless is enabled.
@@ -1463,7 +1463,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 +1481,7 @@ nm_client_wireless_set_enabled (
enabled
-TRUE to enable wireless
+TRUE to enable wireless
@@ -1491,7 +1491,7 @@ nm_client_wireless_set_enabled (
nm_client_wwan_get_enabled ()
-gboolean
+gboolean
nm_client_wwan_get_enabled (NMClient *client);
Determines whether WWAN is enabled.
@@ -1546,7 +1546,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 +1564,7 @@ nm_client_wwan_set_enabled (enabled
-TRUE to enable WWAN
+TRUE to enable WWAN
@@ -1574,7 +1574,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.
@@ -1628,7 +1628,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 +1646,7 @@ nm_client_wimax_set_enabled (enabled
-TRUE to enable WiMAX
+TRUE to enable WiMAX
@@ -1656,7 +1656,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.
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 +1705,14 @@ configuration file.
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 +1733,7 @@ nm_client_connectivity_check_get_enabled
Since: 1.10
@@ -1743,7 +1743,7 @@ nm_client_connectivity_check_get_enabled
void
nm_client_connectivity_check_set_enabled
(NMClient *client,
- gboolean enabled);
+ gboolean enabled);
Enable or disable connectivity checking. Note that if a
connectivity checking URI has not been configured, this will not
have any effect.
@@ -1763,7 +1763,7 @@ have any effect.
enabled
-TRUE to enable connectivity checking
+TRUE to enable connectivity checking
@@ -1774,11 +1774,11 @@ have any effect.
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.
Parameters
@@ -1796,18 +1796,18 @@ nm_client_get_logging (level
- return location for logging level string.
+return location for logging level string.
[allow-none]
domains
- return location for log domains string. The string is
+
return location for log domains string. The string is
a list of domains separated by ",".
[allow-none]
error
-
+
[allow-none]
@@ -1815,17 +1815,17 @@ a list of domains separated by ",".
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 +1843,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).
+logging domains to set. The string should be a list of log
+domains separated by ",". (NULL or an empty string for no change).
[allow-none]
error
-
+
[allow-none]
@@ -1862,7 +1862,7 @@ domains separated by ",". (
Returns
-
+
@@ -1934,8 +1934,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 +1957,12 @@ if you do not want to block.
cancellable
-
+
error
-return location for a GError
+return location for a GError
@@ -1978,9 +1978,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 +2002,7 @@ re-checking, and cancellable
-
+
@@ -2025,8 +2025,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 +2045,12 @@ call.
result
-the GAsyncResult
+the GAsyncResult
error
-return location for a GError
+return location for a GError
@@ -2064,11 +2064,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 +2087,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 +2106,7 @@ clear any existing persistent hostname.
@@ -2115,9 +2115,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,23 +2136,23 @@ 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
callback
- callback to be called when the operation completes.
+callback to be called when the operation completes.
[scope async]
user_data
- caller-specific data passed to callback
+
caller-specific data passed to callback
.
[closure]
@@ -2163,10 +2163,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 +2184,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 +2197,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
@@ -2226,7 +2226,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 +2235,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 +2262,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]
@@ -2300,8 +2300,8 @@ nm_client_get_device_by_path (
Returns
- the NMDevice for the given object_path
-or NULL if none is found.
+the NMDevice for the given object_path
+or NULL if none is found.
[transfer none]
@@ -2336,15 +2336,15 @@ nm_client_get_device_by_iface (
nm_client_get_active_connections ()
-const GPtrArray *
+const GPtrArray *
nm_client_get_active_connections (NMClient *client);
Gets the active connections.
@@ -2364,7 +2364,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 +2383,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
@@ -4210,7 +4210,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” 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 emitted for both
regular devices and placeholder devices.
@@ -4266,7 +4266,7 @@ regular devices and placeholder devices.
device
- the new device.
+the new device.
[type NMDevice]
@@ -4277,15 +4277,15 @@ regular devices and placeholder devices.
-Flags: Run First
+Flags: Run First
The “any-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 emitted for both
regular devices and placeholder devices.
@@ -4304,7 +4304,7 @@ regular devices and placeholder devices.
device
- the removed device.
+the removed device.
[type NMDevice]
@@ -4315,7 +4315,7 @@ regular devices and placeholder devices.
-Flags: Run First
+Flags: Run First
@@ -4323,7 +4323,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
@@ -4360,7 +4360,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
device
- the new device.
+the new device.
[type NMDevice]
@@ -4427,15 +4427,15 @@ placeholder devices.
-Flags: Run First
+Flags: Run First
device
- the removed device.
+the removed device.
[type NMDevice]
@@ -4465,16 +4465,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
+
Generated by GTK-Doc V1.26