From e152ec7bf4ba252ff9d3eb13eabd417b931dac9a Mon Sep 17 00:00:00 2001
From: Iain Lane Registers an error quark for NMClient if necessary. Creates a new NMClient and begins asynchronously initializing it.
cancellable a GCancellable, or a GCancellable, or Gets the result of an error Gets all the known network devices. Use a GPtrArray
-containing all the NMDevices. The returned array is owned by the
+ 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] Gets both real devices and device placeholders (eg, software devices which
do not currently exist, but could be created automatically by NetworkManager
@@ -768,8 +768,8 @@ use device-specific methods such as
a GPtrArray
-containing all the NMDevices. The returned array is owned by the
+ 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] the NMDevice for the given [transfer none] the NMDevice for the given
-GQuark
+GQuark
nm_client_error_quark ()
@@ -75,14 +75,14 @@
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_devices ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_all_devices ()
@@ -146,7 +146,7 @@
-gboolean
+gboolean
nm_client_networking_get_enabled ()
@@ -162,7 +162,7 @@
-gboolean
+gboolean
nm_client_wireless_get_enabled ()
@@ -178,7 +178,7 @@
-gboolean
+gboolean
nm_client_wireless_hardware_get_enabled ()
@@ -186,7 +186,7 @@
-gboolean
+gboolean
nm_client_wwan_get_enabled ()
@@ -202,7 +202,7 @@
-gboolean
+gboolean
nm_client_wwan_hardware_get_enabled ()
@@ -210,7 +210,7 @@
-gboolean
+gboolean
nm_client_wimax_get_enabled ()
@@ -226,7 +226,7 @@
-gboolean
+gboolean
nm_client_wimax_hardware_get_enabled ()
@@ -241,7 +241,7 @@
-NMState
+NMState
nm_client_get_state ()
@@ -249,7 +249,7 @@
-gboolean
+gboolean
nm_client_get_startup ()
@@ -257,14 +257,14 @@
-gboolean
+gboolean
nm_client_get_manager_running ()
-
const GPtrArray *
+ const GPtrArray *
nm_client_get_active_connections ()
@@ -288,7 +288,7 @@
-gboolean
+gboolean
nm_client_get_logging ()
@@ -296,7 +296,7 @@
-gboolean
+gboolean
nm_client_set_logging ()
@@ -304,7 +304,7 @@
-NMConnectivityState
+NMConnectivityState
nm_client_get_connectivity ()
@@ -312,7 +312,7 @@
-NMConnectivityState
+NMConnectivityState
nm_client_check_connectivity ()
@@ -328,7 +328,7 @@
-NMConnectivityState
+NMConnectivityState
nm_client_check_connectivity_finish ()
@@ -381,7 +381,7 @@
Read
-
@@ -392,12 +392,12 @@
guint
+guint
connectivity
Read
Read
-
gboolean
+gboolean
manager-running
Read
-
@@ -408,48 +408,48 @@
gboolean
+gboolean
networking-enabled
Read / Write
Read
-
gboolean
+gboolean
startup
Read
-
guint
+guint
state
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
-
@@ -468,27 +468,27 @@
gboolean
+gboolean
wwan-hardware-enabled
Read
void
any-device-added
-Run First
+Run First
void
any-device-removed
-Run First
+Run First
void
device-added
-Run First
+Run First
void
device-removed
-Run First
+Run First
@@ -590,7 +590,7 @@
void
permission-changed
-Run First
+Run First
Object Hierarchy
- GObject
+
GObject
╰── NMObject
╰── NMClient
@@ -602,7 +602,7 @@
Functions
nm_client_error_quark ()
-GQuark
+
GQuark
nm_client_error_quark (
void);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
@@ -654,7 +654,7 @@ control them. To access and modify network configuration data, use the
-
+NULLNULL
@@ -676,8 +676,8 @@ control them. To access and modify network configuration data, use the
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.
@@ -703,13 +703,13 @@ nm_client_new_finish (
-
+
Returns
-
+
nm_client_get_devices ()
-const GPtrArray *
+
const GPtrArray *
nm_client_get_devices (
NMClient *client);nm_device_get_type() or the
NM_IS_DEVICE_XXXX functions to determine what kind of
@@ -732,8 +732,8 @@ methods such as
Returns
-nm_client_get_all_devices ()
-const GPtrArray *
+
const GPtrArray *
nm_client_get_all_devices (
NMClient *client);Returns
-
Returns
object_path
-or NULL if none is found. NULL if none is found.
Returns
iface
-or NULL if none is found. NULL if none is found.
[transfer none]
@@ -853,19 +853,19 @@ orN
void
(*NMClientActivateFn) (NMClient *client,
NMActiveConnection *active_connection,
- GError *error,
- gpointer user_data);
+ GError *error,
+ gpointer user_data);
nm_client_activate_connection ()
void
nm_client_activate_connection (NMClient *client,
- NMConnection *connection,
+ NMConnection *connection,
NMDevice *device,
const char *specific_object,
NMClientActivateFn callback,
- gpointer user_data);
+ gpointer user_data);
Starts a connection to a particular network using the configuration settings
from connection
and the network device device
@@ -899,7 +899,7 @@ track the activation to its completion.
connection
-an NMConnection.
+an NMConnection.
[allow-none]
@@ -911,7 +911,7 @@ track the activation to its completion.
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
@@ -940,19 +940,19 @@ details of the newly added connection.
(*NMClientAddActivateFn) (NMClient *client,
NMActiveConnection *connection,
const char *new_connection_path,
- GError *error,
- gpointer user_data);
+ GError *error,
+ gpointer user_data);
nm_client_add_and_activate_connection ()
void
nm_client_add_and_activate_connection (NMClient *client,
- NMConnection *partial,
+ NMConnection *partial,
NMDevice *device,
const char *specific_object,
NMClientAddActivateFn callback,
- gpointer user_data);
+ 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 activated.
@@ -977,8 +977,8 @@ track the activation to its completion.
partial
-an NMConnection to add; the connection may be
-partially filled (or even NULL) and will be completed by NetworkManager
+
an NMConnection to add; the connection may be
+partially filled (or even NULL) and will be completed by NetworkManager
using the given device
and specific_object
before being added.
@@ -993,7 +993,7 @@ 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
@@ -1048,7 +1048,7 @@ nm_client_deactivate_connection (
nm_client_networking_get_enabled ()
-gboolean
+gboolean
nm_client_networking_get_enabled (NMClient *client);
Whether networking is enabled or disabled.
@@ -1076,7 +1076,7 @@ nm_client_networking_get_enabled (nm_client_networking_set_enabled ()
void
nm_client_networking_set_enabled (NMClient *client,
- gboolean enabled);
+ gboolean enabled);
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.
@@ -1096,7 +1096,7 @@ 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
@@ -1106,7 +1106,7 @@ 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.
@@ -1134,7 +1134,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
@@ -1152,7 +1152,7 @@ nm_client_wireless_set_enabled (
enabled
-TRUE to enable wireless
+TRUE to enable wireless
@@ -1162,7 +1162,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.
@@ -1217,7 +1217,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
@@ -1235,7 +1235,7 @@ nm_client_wwan_set_enabled (enabled
-TRUE to enable WWAN
+TRUE to enable WWAN
@@ -1245,7 +1245,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.
@@ -1299,7 +1299,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
@@ -1317,7 +1317,7 @@ nm_client_wimax_set_enabled (enabled
-TRUE to enable WiMAX
+TRUE to enable WiMAX
@@ -1327,7 +1327,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.
@@ -1379,7 +1379,7 @@ nm_client_get_version (
nm_client_get_state ()
-NMState
+NMState
nm_client_get_state (NMClient *client);
Gets the current daemon 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.
@@ -1433,7 +1433,7 @@ connections at startup.
nm_client_get_manager_running ()
-gboolean
+gboolean
nm_client_get_manager_running (NMClient *client);
Determines whether the daemon is running.
nm_client_get_active_connections ()
-const GPtrArray *
+const GPtrArray *
nm_client_get_active_connections (NMClient *client);
Gets the active connections.
@@ -1479,8 +1479,8 @@ nm_client_get_active_connections (
Returns
-a GPtrArray
-containing all the active NMActiveConnections.
+
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]
@@ -1490,7 +1490,7 @@ The returned array is owned by the client and should not be modified.
nm_client_sleep ()
void
nm_client_sleep (NMClient *client,
- gboolean sleep_);
+ gboolean sleep_);
Deprecated; use nm_client_networking_set_enabled() instead.
Parameters
@@ -1508,7 +1508,7 @@ nm_client_sleep (sleep_
-TRUE to put the daemon to sleep
+TRUE to put the daemon to sleep
@@ -1553,11 +1553,11 @@ client can or cannot perform the action the permission represents
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
@@ -1586,7 +1586,7 @@ a list of domains separated by ",".
error
-
+
[allow-none]
@@ -1594,18 +1594,18 @@ a list of domains separated by ",".
Since: 0.9.8
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
@@ -1623,18 +1623,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
-
+
[allow-none]
@@ -1642,14 +1642,14 @@ domains separated by ",". (
Since: 0.9.8
nm_client_get_connectivity ()
-NMConnectivityState
+NMConnectivityState
nm_client_get_connectivity (NMClient *client);
Gets the current network connectivity state. Contrast
nm_client_check_connectivity() and
@@ -1679,10 +1679,10 @@ connectivity state first before returning any information.
nm_client_check_connectivity ()
-NMConnectivityState
+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.
@@ -1704,12 +1704,12 @@ if you do not want to block.
cancellable
-
+
error
-return location for a GError
+return location for a GError
@@ -1726,9 +1726,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(),
@@ -1750,7 +1750,7 @@ re-checking, and cancellable
-
+
@@ -1772,10 +1772,10 @@ re-checking, and
nm_client_check_connectivity_finish ()
-NMConnectivityState
+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.
@@ -1794,12 +1794,12 @@ call.
result
-the GAsyncResult
+the GAsyncResult
error
-return location for a GError
+return location for a GError
@@ -1824,7 +1824,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
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.
@@ -2440,15 +2438,15 @@ regular devices and placeholder devices.
-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.
@@ -2478,15 +2476,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.
@@ -2516,16 +2514,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.28