From 28028b26b3371756811e95d894f709f4b1207c00 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 18 Dec 2019 18:29:24 +0100 Subject: New upstream version 1.22.0 --- docs/libnm/html/NMClient.html | 1320 +++++++++++++++-------------------------- 1 file changed, 465 insertions(+), 855 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index ce07ce96..5c2feab2 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -8,7 +8,7 @@ - + @@ -16,10 +16,7 @@ Top  |  Description  |  - Object Hierarchy  |  - Implemented Interfaces  |  - Properties  |  - Signals + Object Hierarchy Home Up @@ -121,6 +118,37 @@ + +GDBusConnection * + + +nm_client_get_dbus_connection () + + + + +GMainContext * + + +nm_client_get_main_context () + + + + +GObject * + + +nm_client_get_context_busy_watcher () + + + +const char * + + +nm_client_get_dbus_name_owner () + + + const char * @@ -153,6 +181,14 @@ +NMMetered + + +nm_client_get_metered () + + + + gboolean @@ -678,221 +714,21 @@ nm_client_checkpoint_adjust_rollback_timeout_finish () - - - -
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NMActiveConnection *activating-connectionRead
-GPtrArray *active-connectionsRead
-GPtrArray *all-devicesRead
gbooleancan-modifyRead
-GPtrArray *checkpointsRead
-GPtrArray *connectionsRead
NMConnectivityStateconnectivityRead
gbooleanconnectivity-check-availableRead
gbooleanconnectivity-check-enabledRead / Write
-GPtrArray *devicesRead
-GPtrArray *dns-configurationRead
-gchar *dns-modeRead
-gchar *dns-rc-managerRead
-gchar *hostnameRead
guintmeteredRead
gbooleannetworking-enabledRead / Write
gbooleannm-runningRead
-NMActiveConnection *primary-connectionRead
gbooleanstartupRead
NMStatestateRead
-gchar *versionRead
gbooleanwimax-enabledRead / Write
gbooleanwimax-hardware-enabledRead
gbooleanwireless-enabledRead / Write
gbooleanwireless-hardware-enabledRead
gbooleanwwan-enabledRead / Write
gbooleanwwan-hardware-enabledRead
-
-
-

Signals

- @@ -923,6 +759,14 @@ #define +NM_CLIENT_DBUS_CONNECTION + + +#define +NM_CLIENT_DBUS_NAME_OWNER + + +#define NM_CLIENT_NETWORKING_ENABLED @@ -931,19 +775,19 @@ #define -NM_CLIENT_WIRELESS_HARDWARE_ENABLED +NM_CLIENT_WWAN_ENABLED #define -NM_CLIENT_WWAN_ENABLED +NM_CLIENT_WIMAX_ENABLED #define -NM_CLIENT_WWAN_HARDWARE_ENABLED +NM_CLIENT_WIRELESS_HARDWARE_ENABLED #define -NM_CLIENT_WIMAX_ENABLED +NM_CLIENT_WWAN_HARDWARE_ENABLED #define @@ -959,6 +803,10 @@ #define +NM_CLIENT_CONNECTIVITY_CHECK_URI + + +#define NM_CLIENT_CONNECTIVITY_CHECK_AVAILABLE @@ -1011,6 +859,10 @@ #define +NM_CLIENT_CHECKPOINTS + + +#define NM_CLIENT_DEVICE_ADDED @@ -1061,10 +913,6 @@ #define NM_CLIENT_ERROR - -  -NMClient -
@@ -1076,17 +924,9 @@ ├── NMClientError ├── NMClientPermission ╰── NMClientPermissionResult - GObject - ╰── NMClient
-

Implemented Interfaces

-

-NMClient implements - GInitable and GAsyncInitable.

-
-

Description

@@ -1377,6 +1217,141 @@ nm_client_new_finish ( +

nm_client_get_dbus_connection ()

+
GDBusConnection *
+nm_client_get_dbus_connection (NMClient *client);
+

Gets the GDBusConnection of the instance. This can be either passed when +constructing the instance (as "dbus-connection" property), or it will be +automatically initialized during async/sync init.

+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

the D-Bus connection of the client, or NULL if none is set.

+

[transfer none]

+
+

Since: 1.22

+
+
+
+

nm_client_get_main_context ()

+
GMainContext *
+nm_client_get_main_context (NMClient *self);
+

The NMClient instance is permanently associated with the current +thread default GMainContext, referenced the time when the instance +was created. To receive events, the user must iterate this context +and can use it to synchronize access to the client.

+

Note that even after NMClient instance got destroyed, there might +still be pending sources registered in the context. That means, to fully +clean up, the user must continue iterating the context as long as +the nm_client_get_context_busy_watcher() object is alive.

+
+

Parameters

+
+++++ + + + + + +

self

the NMClient instance

 
+
+
+

Returns

+

the GMainContext of the client.

+

[transfer none]

+
+

Since: 1.22

+
+
+
+

nm_client_get_context_busy_watcher ()

+
GObject *
+nm_client_get_context_busy_watcher (NMClient *self);
+
+

Parameters

+
+++++ + + + + + +

self

the NMClient instance.

 
+
+
+

Returns

+

a GObject that stays alive as long as there are pending +D-Bus operations.

+

NMClient will schedule asynchronous D-Bus requests which will complete on +the GMainContext associated with the instance. When destroying the NMClient +instance, those requests are cancelled right away, however their pending requests are +still outstanding and queued in the GMainContext. These outstanding callbacks +keep the GMainContext alive. In order to fully release all resources, +the user must keep iterating the main context until all these callbacks +are handled. Of course, at this point no more actual callbacks will be invoked +for the user, those are all internally cancelled.

+

This just leaves one problem: how long does the user need to keep the +GMainContext running to ensure everything is cleaned up? The answer is +this GObject. Subscribe a weak reference to the returned object and keep +iterating the main context until the object got unreferenced.

+

Note that after the NMClient instance gets destroyed, the remaining callbacks +will be invoked right away. That means, the user won't have to iterate the +main context much longer.

+

[transfer none]

+
+

Since: 1.22

+
+
+
+

nm_client_get_dbus_name_owner ()

+
const char *
+nm_client_get_dbus_name_owner (NMClient *client);
+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

the current name owner of the D-Bus service of NetworkManager.

+

[transfer none]

+
+

Since: 1.22

+
+
+

nm_client_get_version ()

const char *
 nm_client_get_version (NMClient *client);
@@ -1482,6 +1457,32 @@ nm_client_get_nm_running ( +

nm_client_get_metered ()

+
NMMetered
+nm_client_get_metered (NMClient *client);
+
+

Parameters

+
+++++ + + + + + +

client

a NMClient

 
+
+
+

Returns

+

whether the default route is metered.

+
+

Since: 1.22

+
+
+

nm_client_networking_get_enabled ()

gboolean
 nm_client_networking_get_enabled (NMClient *client);
@@ -1513,6 +1514,10 @@ nm_client_networking_get_enabled (NMClient *client, gboolean enabled, GError **error); +
+

nm_client_networking_set_enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_networking_set_enabled_async() or GDBusConnection

+

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.

@@ -1580,6 +1585,10 @@ nm_client_wireless_get_enabled (void nm_client_wireless_set_enabled (NMClient *client, gboolean enabled); +
+

nm_client_wireless_set_enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_wireless_set_enabled_async() or GDBusConnection

+

Enables or disables wireless devices.

Parameters

@@ -1663,6 +1672,7 @@ nm_client_wwan_get_enabled (void nm_client_wwan_set_enabled (NMClient *client, gboolean enabled); +

nm_client_wwan_set_enabled is deprecated and should not be used in newly-written code.

Enables or disables WWAN devices.

Parameters

@@ -1718,6 +1728,10 @@ nm_client_wwan_hardware_get_enabled (

nm_client_wimax_get_enabled ()

gboolean
 nm_client_wimax_get_enabled (NMClient *client);
+
+

nm_client_wimax_get_enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

This function always returns FALSE because WiMax is no longer supported

+

Determines whether WiMAX is enabled.

Parameters

@@ -1745,6 +1759,10 @@ nm_client_wimax_get_enabled (void nm_client_wimax_set_enabled (NMClient *client, gboolean enabled); +
+

nm_client_wimax_set_enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

This function does nothing because WiMax is no longer supported

+

Enables or disables WiMAX devices.

Parameters

@@ -1774,6 +1792,10 @@ nm_client_wimax_set_enabled (

nm_client_wimax_hardware_get_enabled ()

gboolean
 nm_client_wimax_hardware_get_enabled (NMClient *client);
+
+

nm_client_wimax_hardware_get_enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

This function always returns FALSE because WiMax is no longer supported

+

Determines whether the WiMAX hardware is enabled.

Parameters

@@ -1860,6 +1882,7 @@ nm_client_connectivity_check_get_enabled nm_client_connectivity_check_set_enabled (NMClient *client, gboolean enabled); +

nm_client_connectivity_check_set_enabled is deprecated and should not be used in newly-written code.

Enable or disable connectivity checking. Note that if a connectivity checking URI has not been configured, this will not have any effect.

@@ -1924,6 +1947,10 @@ nm_client_get_logging (char **level, char **domains, GError **error); +
+

nm_client_get_logging has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_get_logging_async() or GDBusConnection

+

Gets NetworkManager current logging level and domains.

Parameters

@@ -1971,6 +1998,10 @@ nm_client_set_logging (const char *level, const char *domains, GError **error); +
+

nm_client_set_logging has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_set_logging_async() or GDBusConnection

+

Sets NetworkManager logging level and/or domains.

Parameters

@@ -2081,6 +2112,10 @@ connectivity state first before returning any information.

nm_client_check_connectivity (NMClient *client, GCancellable *cancellable, GError **error); +
+

nm_client_check_connectivity has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_check_connectivity_async() or GDBusConnection

+

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.

@@ -2214,6 +2249,10 @@ nm_client_save_hostname (const char *hostname, GCancellable *cancellable, GError **error); +
+

nm_client_save_hostname has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_save_hostname_async() or GDBusConnection

+

Requests that the machine's persistent hostname be set to the specified value or cleared.

@@ -2510,7 +2549,7 @@ nm_client_get_active_connections (

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]

@@ -2558,7 +2597,7 @@ any.

nm_client_get_activating_connection (NMClient *client);

Gets the NMActiveConnection corresponding to a currently-activating connection that is expected to become the new -“primary-connection” upon successful activation.

+“primary-connection” upon successful activation.

Parameters

@@ -2608,7 +2647,7 @@ in connection picks the best available connection for the device and activates it.

Note that the callback is invoked when NetworkManager has started activating the new connection, not when it finishes. You can use the returned -NMActiveConnection object (in particular, “state”) to +NMActiveConnection object (in particular, “state”) to track the activation to its completion.

Parameters

@@ -2728,7 +2767,7 @@ activated as with NMActiveConnection object (in particular, “state”) to +NMActiveConnection object (in particular, “state”) to track the activation to its completion.

Parameters

@@ -2767,7 +2806,8 @@ wired and mobile broadband connections, and the value of NMAccessPoint or NMWimaxNsp owned by device , which you can get using nm_object_get_path(), and which will be used to complete the -details of the newly added connection.

+details of the newly added connection. +If the variant is floating, it will be consumed.

@@ -2856,7 +2896,7 @@ activated as with NMActiveConnection object (in particular, “state”) to +NMActiveConnection object (in particular, “state”) to track the activation to its completion.

This is identitcal to nm_client_add_and_activate_connection_async() but takes a further options @@ -2999,6 +3039,10 @@ nm_client_deactivate_connection (NMActiveConnection *active, GCancellable *cancellable, GError **error); +

+

nm_client_deactivate_connection has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_deactivate_connection_async() or GDBusConnection

+

Deactivates an active NMActiveConnection.

Parameters

@@ -3524,6 +3568,10 @@ nm_client_load_connections (char ***failures, GCancellable *cancellable, GError **error); +
+

nm_client_load_connections has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_load_connections_async() or GDBusConnection

+

Requests that the remote settings service load or reload the given files, adding or updating the connections described within.

The changes to the indicated files will not yet be reflected in @@ -3576,9 +3624,19 @@ filenames that failed to load.

Returns

-

TRUE if NetworkManager at least tried to load filenames -, -FALSE if an error occurred (eg, permission denied).

+

TRUE on success.

+

Warning: before libnm 1.22, the boolean return value was inconsistent. +That is made worse, because when running against certain server versions +before 1.20, the server would return wrong values for success/failure. +This means, if you use this function in libnm before 1.22, you are advised +to ignore the boolean return value and only look at failures +and error +. +With libnm >= 1.22, the boolean return value corresponds to whether error +was +set. Note that even in the success case, you might have individual failures +. +With 1.22, the return value is consistent with nm_client_load_connections_finish().


@@ -3677,9 +3735,9 @@ nm_client_load_connections_finish (

Returns

-

TRUE if NetworkManager at least tried to load filenames -, -FALSE if an error occurred (eg, permission denied).

+

TRUE on success. +Note that even in the success case, you might have individual failures +.


@@ -3689,6 +3747,10 @@ nm_client_load_connections_finish (NMClient *client, GCancellable *cancellable, GError **error); +
+

nm_client_reload_connections has been deprecated since version 1.22 and should not be used in newly-written code.

+

, use nm_client_reload_connections_async() or GDBusConnection

+

Requests that the remote settings service reload all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state.

@@ -4328,30 +4390,138 @@ nm_client_checkpoint_adjust_rollback_timeout_finish

Since: 1.12

+
+
+

nm_client_reload ()

+
void
+nm_client_reload (NMClient *client,
+                  NMManagerReloadFlags flags,
+                  GCancellable *cancellable,
+                  GAsyncReadyCallback callback,
+                  gpointer user_data);
+

Reload NetworkManager's configuration and perform certain updates, like +flushing caches or rewriting external state to disk. This is similar to +sending SIGHUP to NetworkManager but it allows for more fine-grained control +over what to reload (see flags +). It also allows non-root access via +PolicyKit and contrary to signals it is synchronous.

+
+

Parameters

+
[allow-none]
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

client

the NMClient

 

flags

flags indicating what to reload.

 

cancellable

a GCancellable, or NULL

 

callback

callback to be called when the add operation completes.

[scope async]

user_data

caller-specific data passed to callback +.

[closure]
+
+

Since: 1.22

+
+
+
+

nm_client_reload_finish ()

+
gboolean
+nm_client_reload_finish (NMClient *client,
+                         GAsyncResult *result,
+                         GError **error);
+

Gets the result of a call to nm_client_reload().

+
+

Parameters

+
+++++ + + + + + + + + + + + + + + + + + +

client

an NMClient

 

result

the result passed to the GAsyncReadyCallback

 

error

location for a GError, or NULL

 
+
+
+

Returns

+

TRUE on success or FALSE on failure.

+
+

Since: 1.22

+

Types and Values

NM_CLIENT_VERSION

-
#define NM_CLIENT_VERSION "version"
+
#define NM_CLIENT_VERSION         "version"
 

NM_CLIENT_STATE

-
#define NM_CLIENT_STATE "state"
+
#define NM_CLIENT_STATE           "state"
 

NM_CLIENT_STARTUP

-
#define NM_CLIENT_STARTUP "startup"
+
#define NM_CLIENT_STARTUP         "startup"
 

NM_CLIENT_NM_RUNNING

-
#define NM_CLIENT_NM_RUNNING "nm-running"
+
#define NM_CLIENT_NM_RUNNING      "nm-running"
+
+
+
+
+

NM_CLIENT_DBUS_CONNECTION

+
#define NM_CLIENT_DBUS_CONNECTION "dbus-connection"
+
+
+
+
+

NM_CLIENT_DBUS_NAME_OWNER

+
#define NM_CLIENT_DBUS_NAME_OWNER "dbus-name-owner"
 

@@ -4359,35 +4529,39 @@ nm_client_checkpoint_adjust_rollback_timeout_finish

NM_CLIENT_NETWORKING_ENABLED

#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
 
+

NM_CLIENT_NETWORKING_ENABLED is deprecated and should not be used in newly-written code.


NM_CLIENT_WIRELESS_ENABLED

#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
 
+

NM_CLIENT_WIRELESS_ENABLED is deprecated and should not be used in newly-written code.


-

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

-
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
+

NM_CLIENT_WWAN_ENABLED

+
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
 
+

NM_CLIENT_WWAN_ENABLED is deprecated and should not be used in newly-written code.


-

NM_CLIENT_WWAN_ENABLED

-
#define NM_CLIENT_WWAN_ENABLED "wwan-enabled"
+

NM_CLIENT_WIMAX_ENABLED

+
#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
 
+

NM_CLIENT_WIMAX_ENABLED is deprecated and should not be used in newly-written code.


-

NM_CLIENT_WWAN_HARDWARE_ENABLED

-
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
+

NM_CLIENT_WIRELESS_HARDWARE_ENABLED

+
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
 

-

NM_CLIENT_WIMAX_ENABLED

-
#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
+

NM_CLIENT_WWAN_HARDWARE_ENABLED

+
#define NM_CLIENT_WWAN_HARDWARE_ENABLED "wwan-hardware-enabled"
 

@@ -4410,6 +4584,12 @@ nm_client_checkpoint_adjust_rollback_timeout_finish

+

NM_CLIENT_CONNECTIVITY_CHECK_URI

+
#define NM_CLIENT_CONNECTIVITY_CHECK_URI "connectivity-check-uri"
+
+
+
+

NM_CLIENT_CONNECTIVITY_CHECK_AVAILABLE

#define NM_CLIENT_CONNECTIVITY_CHECK_AVAILABLE "connectivity-check-available"
 
@@ -4419,6 +4599,7 @@ nm_client_checkpoint_adjust_rollback_timeout_finish

NM_CLIENT_CONNECTIVITY_CHECK_ENABLED

#define NM_CLIENT_CONNECTIVITY_CHECK_ENABLED "connectivity-check-enabled"
 
+

NM_CLIENT_CONNECTIVITY_CHECK_ENABLED is deprecated and should not be used in newly-written code.


@@ -4488,6 +4669,12 @@ nm_client_checkpoint_adjust_rollback_timeout_finish

+

NM_CLIENT_CHECKPOINTS

+
#define NM_CLIENT_CHECKPOINTS "checkpoints"
+
+
+
+

NM_CLIENT_DEVICE_ADDED

#define NM_CLIENT_DEVICE_ADDED "device-added"
 
@@ -4565,7 +4752,7 @@ clients can obtain to perform certain tasks on behalf of the current user.

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

controls whether networking -can be globally enabled or disabled

+ can be globally enabled or disabled

  @@ -4573,7 +4760,7 @@ can be globally enabled or disabled

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

controls whether Wi-Fi can be -globally enabled or disabled

+ globally enabled or disabled

  @@ -4581,7 +4768,7 @@ globally enabled or disabled

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

controls whether WWAN (3G) can be -globally enabled or disabled

+ globally enabled or disabled

  @@ -4589,7 +4776,7 @@ globally enabled or disabled

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

controls whether WiMAX can be -globally enabled or disabled

+ globally enabled or disabled

  @@ -4597,7 +4784,7 @@ globally enabled or disabled

NM_CLIENT_PERMISSION_SLEEP_WAKE

controls whether the client can ask -NetworkManager to sleep and wake

+ NetworkManager to sleep and wake

  @@ -4605,7 +4792,7 @@ NetworkManager to sleep and wake

NM_CLIENT_PERMISSION_NETWORK_CONTROL

controls whether networking connections -can be started, stopped, and changed

+ can be started, stopped, and changed

  @@ -4613,7 +4800,7 @@ can be started, stopped, and changed

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

controls whether a password -protected Wi-Fi hotspot can be created

+ protected Wi-Fi hotspot can be created

  @@ -4621,7 +4808,7 @@ protected Wi-Fi hotspot can be created

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

controls whether an open Wi-Fi hotspot -can be created

+ can be created

  @@ -4629,7 +4816,7 @@ can be created

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

controls whether connections -that are available to all users can be modified

+ that are available to all users can be modified

  @@ -4637,7 +4824,7 @@ that are available to all users can be modified

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN

controls whether connections -owned by the current user can be modified

+ owned by the current user can be modified

  @@ -4645,7 +4832,7 @@ owned by the current user can be modified

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

controls whether the -persistent hostname can be changed

+ persistent hostname can be changed

  @@ -4653,7 +4840,7 @@ persistent hostname can be changed

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_GLOBAL_DNS

modify persistent global -DNS configuration

+ DNS configuration

  @@ -4675,7 +4862,7 @@ DNS configuration

NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS

controls whether device -statistics can be globally enabled or disabled

+ statistics can be globally enabled or disabled

  @@ -4683,7 +4870,7 @@ statistics can be globally enabled or disabled

NM_CLIENT_PERMISSION_ENABLE_DISABLE_CONNECTIVITY_CHECK

controls whether -connectivity check can be enabled or disabled

+ connectivity check can be enabled or disabled

  @@ -4737,7 +4924,7 @@ the user requires to obtain a given

NM_CLIENT_PERMISSION_RESULT_AUTH

authorization is necessary before the -permission is available

+ permission is available

  @@ -4745,7 +4932,7 @@ permission is available

NM_CLIENT_PERMISSION_RESULT_NO

permission to perform the operation is -denied by system policy

+ denied by system policy

  @@ -4779,7 +4966,7 @@ denied by system policy

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

an operation that requires NetworkManager -failed because NetworkManager is not running

+ failed because NetworkManager is not running

  @@ -4787,9 +4974,9 @@ failed because NetworkManager is not running

NM_CLIENT_ERROR_OBJECT_CREATION_FAILED

NetworkManager claimed that an -operation succeeded, but the object that was allegedly created (eg, -NMRemoteConnection, NMActiveConnection) was apparently destroyed before -NMClient could create a representation of it.

+ operation succeeded, but the object that was allegedly created (eg, + NMRemoteConnection, NMActiveConnection) was apparently destroyed before + NMClient could create a representation of it.

  @@ -4803,586 +4990,9 @@ operation succeeded, but the object that was allegedly created (eg,
#define NM_CLIENT_ERROR nm_client_error_quark ()
 
-
-
-

NMClient

-
typedef struct _NMClient NMClient;
-
-
-
-

Property Details

-
-

The “activating-connection” property

-
  “activating-connection”    NMActiveConnection *
-

The NMActiveConnection of the activating connection that is -likely to become the new “primary-connection”.

-

Flags: Read

-
-
-
-

The “active-connections” property

-
  “active-connections”       GPtrArray *
-

The active connections.

-

[type GPtrArray(NMActiveConnection)]

-

Flags: Read

-
-
-
-

The “all-devices” property

-
  “all-devices”              GPtrArray *
-

List of both real devices and device placeholders.

-

[type GPtrArray(NMDevice)]

-

Flags: Read

-

Since: 1.2

-
-
-
-

The “can-modify” property

-
  “can-modify”               gboolean
-

If TRUE, adding and modifying connections is supported.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “checkpoints” property

-
  “checkpoints”              GPtrArray *
-

The list of active checkpoints.

-

[type GPtrArray(NMCheckpoint)]

-

Flags: Read

-

Since: 1.12

-
-
-
-

The “connections” property

-
  “connections”              GPtrArray *
-

The list of configured connections that are available to the user. (Note -that this differs from the underlying D-Bus property, which may also -contain the object paths of connections that the user does not have -permission to read the details of.)

-

[type GPtrArray(NMRemoteConnection)]

-

Flags: Read

-
-
-
-

The “connectivity” property

-
  “connectivity”             NMConnectivityState
-

The network connectivity state.

-

Flags: Read

-

Default value: NM_CONNECTIVITY_UNKNOWN

-
-
-
-

The “connectivity-check-available” property

-
  “connectivity-check-available” gboolean
-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “connectivity-check-enabled” property

-
  “connectivity-check-enabled” gboolean
-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “devices” property

-
  “devices”                  GPtrArray *
-

List of real network devices. Does not include placeholder devices.

-

[type GPtrArray(NMDevice)]

-

Flags: Read

-
-
-
-

The “dns-configuration” property

-
  “dns-configuration”        GPtrArray *
-

The current DNS configuration, represented as an array -of NMDnsEntry objects.

-

[type GPtrArray(NMDnsEntry)]

-

Flags: Read

-

Since: 1.6

-
-
-
-

The “dns-mode” property

-
  “dns-mode”                 gchar *
-

The current DNS processing mode.

-

Flags: Read

-

Default value: ""

-

Since: 1.6

-
-
-
-

The “dns-rc-manager” property

-
  “dns-rc-manager”           gchar *
-

The current resolv.conf management mode.

-

Flags: Read

-

Default value: ""

-

Since: 1.6

-
-
-
-

The “hostname” property

-
  “hostname”                 gchar *
-

The machine hostname stored in persistent configuration. This can be -modified by calling nm_client_save_hostname().

-

Flags: Read

-

Default value: NULL

-
-
-
-

The “metered” property

-
  “metered”                  guint
-

Whether the connectivity is metered.

-

Flags: Read

-

Default value: 0

-

Since: 1.2

-
-
-
-

The “networking-enabled” property

-
  “networking-enabled”       gboolean
-

Whether networking is enabled.

-

Flags: Read / Write

-

Default value: TRUE

-
-
-
-

The “nm-running” property

-
  “nm-running”               gboolean
-

Whether the daemon is running.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “primary-connection” property

-
  “primary-connection”       NMActiveConnection *
-

The NMActiveConnection of the device with the default route; -see nm_client_get_primary_connection() for more details.

-

Flags: Read

-
-
-
-

The “startup” property

-
  “startup”                  gboolean
-

Whether the daemon is still starting up.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “state” property

-
  “state”                    NMState
-

The current daemon state.

-

Flags: Read

-

Default value: NM_STATE_UNKNOWN

-
-
-
-

The “version” property

-
  “version”                  gchar *
-

The NetworkManager version.

-

Flags: Read

-

Default value: NULL

-
-
-
-

The “wimax-enabled” property

-
  “wimax-enabled”            gboolean
-

Whether WiMAX functionality is enabled.

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “wimax-hardware-enabled” property

-
  “wimax-hardware-enabled”   gboolean
-

Whether the WiMAX hardware is enabled.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “wireless-enabled” property

-
  “wireless-enabled”         gboolean
-

Whether wireless is enabled.

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “wireless-hardware-enabled” property

-
  “wireless-hardware-enabled” gboolean
-

Whether the wireless hardware is enabled.

-

Flags: Read

-

Default value: TRUE

-
-
-
-

The “wwan-enabled” property

-
  “wwan-enabled”             gboolean
-

Whether WWAN functionality is enabled.

-

Flags: Read / Write

-

Default value: FALSE

-
-
-
-

The “wwan-hardware-enabled” property

-
  “wwan-hardware-enabled”    gboolean
-

Whether the WWAN hardware is enabled.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

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,
-               GObject  *device,
-               gpointer  user_data)
-

Notifies that a NMDevice is added. This signal is emitted for both -regular devices and placeholder devices.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the client that received the signal

 

device

the new device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “any-device-removed” signal

-
void
-user_function (NMClient *client,
-               GObject  *device,
-               gpointer  user_data)
-

Notifies that a NMDevice is removed. This signal is emitted for both -regular devices and placeholder devices.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the client that received the signal

 

device

the removed device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “connection-added” signal

-
void
-user_function (NMClient           *client,
-               NMRemoteConnection *connection,
-               gpointer            user_data)
-

Notifies that a NMConnection has been added.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the settings object that received the signal

 

connection

the new connection

 

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “connection-removed” signal

-
void
-user_function (NMClient           *client,
-               NMRemoteConnection *connection,
-               gpointer            user_data)
-

Notifies that a NMConnection has been removed.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the settings object that received the signal

 

connection

the removed connection

 

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “device-added” signal

-
void
-user_function (NMClient *client,
-               GObject  *device,
-               gpointer  user_data)
-

Notifies that a NMDevice is added. This signal is not emitted for -placeholder devices.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the client that received the signal

 

device

the new device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “device-removed” signal

-
void
-user_function (NMClient *client,
-               GObject  *device,
-               gpointer  user_data)
-

Notifies that a NMDevice is removed. This signal is not emitted for -placeholder devices.

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - -

client

the client that received the signal

 

device

the removed device.

[type NMDevice]

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
-
-
-

The “permission-changed” signal

-
void
-user_function (NMClient *client,
-               guint     permission,
-               guint     result,
-               gpointer  user_data)
-

Notifies that a permission has changed

-
-

Parameters

-
----- - - - - - - - - - - - - - - - - - - - - - - -

client

the client that received the signal

 

permission

a permission from NMClientPermission

 

result

the permission's result, one of NMClientPermissionResult

 

user_data

user data set when the signal handler was connected.

 
-
-

Flags: Run First

-
+
Generated by GTK-Doc V1.29
\ No newline at end of file -- cgit 1.3.0-6-gf8a5