From 1e5977b62f896e844b548c3007ace9e1dfa7f9ed Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sat, 11 Apr 2020 21:28:04 +0200 Subject: New upstream version 1.23.90 --- docs/libnm/html/NMClient.html | 772 ++++++++++++++++++++++++++++-------------- 1 file changed, 513 insertions(+), 259 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index 8d27ad9c..9c7c1a45 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -8,7 +8,7 @@ - + @@ -36,8 +36,8 @@

Functions

--++ @@ -119,6 +119,14 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMClientInstanceFlags + +nm_client_get_instance_flags () +
GDBusConnection * @@ -181,6 +189,14 @@
+NMObject * + +nm_client_get_object_by_path () +
NMMetered @@ -331,7 +347,7 @@
-NMClientPermissionResult +NMClientPermissionResult nm_client_get_permission_result () @@ -339,6 +355,14 @@
+NMTernary + +nm_client_get_permissions_state () +
NMConnectivityState @@ -737,6 +761,38 @@ nm_client_reload_finish ()
+void + +nm_client_dbus_call () +
+GVariant * + +nm_client_dbus_call_finish () +
+void + +nm_client_dbus_set_property () +
+gboolean + +nm_client_dbus_set_property_finish () +
@@ -744,11 +800,15 @@

Types and Values

--++ + + + + @@ -774,6 +834,10 @@ + + + + @@ -874,6 +938,10 @@ + + + + @@ -910,14 +978,6 @@ - - - - - - - - @@ -932,9 +992,9 @@
    GBoxed
     ╰── NMDnsEntry
     GEnum
-    ├── NMClientError
-    ├── NMClientPermission
-    ╰── NMClientPermissionResult
+    ╰── NMClientError
+    GFlags
+    ╰── NMClientInstanceFlags
 
@@ -1228,6 +1288,32 @@ nm_client_new_finish ( +

nm_client_get_instance_flags ()

+
NMClientInstanceFlags
+nm_client_get_instance_flags (NMClient *self);
+
+

Parameters

+
enumNMClientInstanceFlags
#define NM_CLIENT_VERSION
#defineNM_CLIENT_INSTANCE_FLAGS
#define NM_CLIENT_NETWORKING_ENABLED
#defineNM_CLIENT_PERMISSIONS_STATE
#define NM_CLIENT_DEVICE_ADDED
enumNMClientPermission
enumNMClientPermissionResult
enum NMClientError
+++++ + + + + + +

self

the NMClient instance.

 
+ +
+

Returns

+

the NMClientInstanceFlags flags.

+
+

Since: 1.24

+ +
+

nm_client_get_dbus_connection ()

GDBusConnection *
 nm_client_get_dbus_connection (NMClient *client);
@@ -1468,6 +1554,43 @@ nm_client_get_nm_running ( +

nm_client_get_object_by_path ()

+
NMObject *
+nm_client_get_object_by_path (NMClient *client,
+                              const char *dbus_path);
+
+

Parameters

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

client

the NMClient instance

 

dbus_path

the D-Bus path of the object to look up

 
+
+
+

Returns

+

the NMObject instance that is +cached under dbus_path +, or NULL if no such object exists.

+

[transfer none]

+
+

Since: 1.24

+
+
+

nm_client_get_metered ()

NMMetered
 nm_client_get_metered (NMClient *client);
@@ -1557,7 +1680,7 @@ at position length .

[transfer none][array length=length]

-

Since: 1.24, 1.22.2

+

Since: 1.24


@@ -1568,7 +1691,8 @@ nm_client_networking_set_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

+

Use the async command nm_client_dbus_call() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to call "Enable" with "(b)" arguments and no return value.

Enables or disables networking. When networking is disabled, all controlled interfaces are disconnected and deactivated. When networking is enabled, @@ -1639,7 +1763,8 @@ nm_client_wireless_set_enabled (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

+

Use the async command nm_client_dbus_set_property() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to set "WirelessEnabled" property to a "(b)" value.

Enables or disables wireless devices.

@@ -1724,7 +1849,11 @@ 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.

+
+

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

+

Use the async command nm_client_dbus_set_property() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to set "WwanEnabled" property to a "(b)" value.

+

Enables or disables WWAN devices.

Parameters

@@ -1782,7 +1911,7 @@ nm_client_wwan_hardware_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

+

This function always returns FALSE because WiMax is no longer supported.

Determines whether WiMAX is enabled.

@@ -1813,7 +1942,7 @@ nm_client_wimax_set_enabled (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

+

This function does nothing because WiMax is no longer supported.

Enables or disables WiMAX devices.

@@ -1846,7 +1975,7 @@ nm_client_wimax_set_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

+

This function always returns FALSE because WiMax is no longer supported.

Determines whether the WiMAX hardware is enabled.

@@ -1934,7 +2063,11 @@ 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.

+
+

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

+

Use the async command nm_client_dbus_set_property() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to set "ConnectivityCheckEnabled" property to a "(b)" value.

+

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

@@ -2001,7 +2134,9 @@ nm_client_get_logging (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

+

Use the async command nm_client_dbus_call() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to call "GetLogging" with no arguments to get "(ss)" for level +and domains.

Gets NetworkManager current logging level and domains.

@@ -2052,7 +2187,8 @@ nm_client_set_logging (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

+

Use the async command nm_client_dbus_call() on NM_DBUS_PATH, +NM_DBUS_INTERFACE to call "SetLogging" with "(ss)" arguments for level and domains.

Sets NetworkManager logging level and/or domains.

@@ -2096,9 +2232,9 @@ domains separated by ",". (

nm_client_get_permission_result ()

-
NMClientPermissionResult
+
NMClientPermissionResult
 nm_client_get_permission_result (NMClient *client,
-                                 NMClientPermission permission);
+ NMClientPermission permission);

Requests the result of a specific permission, which indicates whether the client can or cannot perform the action the permission represents

@@ -2117,7 +2253,7 @@ client can or cannot perform the action the permission represents

permission

-

the permission for which to return the result, one of NMClientPermission

+

the permission for which to return the result, one of NMClientPermission

  @@ -2125,8 +2261,39 @@ client can or cannot perform the action the permission represents

Returns

-

the permission's result, one of NMClientPermissionResult

+

the permission's result, one of NMClientPermissionResult

+
+
+
+
+

nm_client_get_permissions_state ()

+
NMTernary
+nm_client_get_permissions_state (NMClient *self);
+
+

Parameters

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

self

the NMClient instance

 
+
+

Returns

+

the state of the cached permissions. NM_TERNARY_DEFAULT +means that no permissions result was yet received. All permissions +are unknown. NM_TERNARY_TRUE means that the permissions got received +and are cached. %NM_TERNARY_FALSE means that permissions are cached, +but they are invalided as as "CheckPermissions" signal was received +in the meantime.

+
+

Since: 1.24


@@ -2166,7 +2333,7 @@ nm_client_check_connectivity (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

+

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 @@ -2303,7 +2470,7 @@ nm_client_save_hostname (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

+

Use nm_client_save_hostname_async() or GDBusConnection.

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

@@ -2601,7 +2768,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]

@@ -2649,7 +2816,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

@@ -2699,7 +2866,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

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

Parameters

@@ -2948,7 +3115,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 @@ -3093,7 +3260,7 @@ nm_client_deactivate_connection (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

+

Use nm_client_deactivate_connection_async() or GDBusConnection.

Deactivates an active NMActiveConnection.

@@ -3622,7 +3789,7 @@ nm_client_load_connections (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

+

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.

@@ -3801,7 +3968,7 @@ nm_client_reload_connections (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

+

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 @@ -4538,10 +4705,298 @@ nm_client_reload_finish (Since: 1.22

+
+
+

nm_client_dbus_call ()

+
void
+nm_client_dbus_call (NMClient *client,
+                     const char *object_path,
+                     const char *interface_name,
+                     const char *method_name,
+                     GVariant *parameters,
+                     const GVariantType *reply_type,
+                     int timeout_msec,
+                     GCancellable *cancellable,
+                     GAsyncReadyCallback callback,
+                     gpointer user_data);
+

Call g_dbus_connection_call() on the current name owner with the specified +arguments. Most importantly, this invokes g_dbus_connection_call() with the +client's GMainContext, so that the response is always in order with other +events D-Bus events. Of course, the call uses GTask and will invoke the +callback on the current g_main_context_get_thread_default().

+

This API is merely a convenient wrapper for g_dbus_connection_call(). You can +also use g_dbus_connection_call() directly, with the same effect.

+
+

Parameters

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

client

the NMClient

 

object_path

path of remote object

 

interface_name

D-Bus interface to invoke method on

 

method_name

the name of the method to invoke

 

parameters

a GVariant tuple with parameters for the method +or NULL if not passing parameters.

[nullable]

reply_type

the expected type of the reply (which will be a +tuple), or NULL.

[nullable]

timeout_msec

the timeout in milliseconds, -1 to use the default +timeout or G_MAXINT for no timeout

 

cancellable

a GCancellable or NULL.

[nullable]

callback

a GAsyncReadyCallback to call when the request +is satisfied or NULL if you don't care about the result of the +method invocation.

[nullable]

user_data

the data to pass to callback +

 
+
+

Since: 1.24

+
+
+
+

nm_client_dbus_call_finish ()

+
GVariant *
+nm_client_dbus_call_finish (NMClient *client,
+                            GAsyncResult *result,
+                            GError **error);
+

Gets the result of a call to nm_client_dbus_call().

+
+

Parameters

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

client

the NMClient instance

 

result

the result passed to the GAsyncReadyCallback

 

error

location for a GError, or NULL

 
+
+
+

Returns

+

the result GVariant or NULL on error.

+

[transfer full]

+
+

Since: 1.24

+
+
+
+

nm_client_dbus_set_property ()

+
void
+nm_client_dbus_set_property (NMClient *client,
+                             const char *object_path,
+                             const char *interface_name,
+                             const char *property_name,
+                             GVariant *value,
+                             int timeout_msec,
+                             GCancellable *cancellable,
+                             GAsyncReadyCallback callback,
+                             gpointer user_data);
+

Like nm_client_dbus_call() but calls "Set" on the standard "org.freedesktop.DBus.Properties" +D-Bus interface.

+
+

Parameters

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

client

the NMClient

 

object_path

path of remote object

 

interface_name

D-Bus interface to invoke method on

 

property_name

the name of the property to set

 

value

a GVariant tuple with the value to set

 

timeout_msec

the timeout in milliseconds, -1 to use the default +timeout or G_MAXINT for no timeout

 

cancellable

a GCancellable or NULL.

[nullable]

callback

a GAsyncReadyCallback to call when the request +is satisfied or NULL if you don't care about the result of the +method invocation.

[nullable]

user_data

the data to pass to callback +

 
+
+

Since: 1.24

+
+
+
+

nm_client_dbus_set_property_finish ()

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

Gets the result of a call to nm_client_dbus_set_property().

+
+

Parameters

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

client

the NMClient instance

 

result

the result passed to the GAsyncReadyCallback

 

error

location for a GError, or NULL

 
+
+
+

Returns

+

TRUE on success or FALSE on failure.

+
+

Since: 1.24

+

Types and Values

+

enum NMClientInstanceFlags

+
+

Members

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

NM_CLIENT_INSTANCE_FLAGS_NONE

+

special value to indicate no flags.

+
 

NM_CLIENT_INSTANCE_FLAGS_NO_AUTO_FETCH_PERMISSIONS

+

by default, NMClient +will fetch the permissions via "GetPermissions" and refetch them when +"CheckPermissions" signal gets received. By setting this flag, this behavior +can be disabled. You can toggle this flag to enable and disable automatic +fetching of the permissions. Watch also nm_client_get_permissions_state() +to know whether the permissions are up to date.

+
 
+
+

Since: 1.24

+
+
+

NM_CLIENT_VERSION

#define NM_CLIENT_VERSION         "version"
 
@@ -4578,6 +5033,12 @@ nm_client_reload_finish ( +

NM_CLIENT_INSTANCE_FLAGS

+
#define NM_CLIENT_INSTANCE_FLAGS  "instance-flags"
+
+
+
+

NM_CLIENT_NETWORKING_ENABLED

#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
 
@@ -4733,6 +5194,12 @@ nm_client_reload_finish ( +

NM_CLIENT_PERMISSIONS_STATE

+
#define NM_CLIENT_PERMISSIONS_STATE "permissions-state"
+
+
+
+

NM_CLIENT_DEVICE_ADDED

#define NM_CLIENT_DEVICE_ADDED "device-added"
 
@@ -4787,219 +5254,6 @@ nm_client_reload_finish ( -

enum NMClientPermission

-

NMClientPermission values indicate various permissions that NetworkManager -clients can obtain to perform certain tasks on behalf of the current user.

-
-

Members

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

NM_CLIENT_PERMISSION_NONE

-

unknown or no permission

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK

-

controls whether networking - can be globally enabled or disabled

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI

-

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

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN

-

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

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX

-

controls whether WiMAX can be - globally enabled or disabled

-
 

NM_CLIENT_PERMISSION_SLEEP_WAKE

-

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

-
 

NM_CLIENT_PERMISSION_NETWORK_CONTROL

-

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

-
 

NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED

-

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

-
 

NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN

-

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

-
 

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM

-

controls whether connections - 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

-
 

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME

-

controls whether the - persistent hostname can be changed

-
 

NM_CLIENT_PERMISSION_SETTINGS_MODIFY_GLOBAL_DNS

-

modify persistent global - DNS configuration

-
 

NM_CLIENT_PERMISSION_RELOAD

-

controls access to Reload.

-
 

NM_CLIENT_PERMISSION_CHECKPOINT_ROLLBACK

-

permission to create checkpoints.

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS

-

controls whether device - statistics can be globally enabled or disabled

-
 

NM_CLIENT_PERMISSION_ENABLE_DISABLE_CONNECTIVITY_CHECK

-

controls whether - connectivity check can be enabled or disabled

-
 

NM_CLIENT_PERMISSION_WIFI_SCAN

-

controls whether wifi scans can be performed

-
 

NM_CLIENT_PERMISSION_LAST

-

a reserved boundary value

-
 
-
-
-
-
-

enum NMClientPermissionResult

-

NMClientPermissionResult values indicate what authorizations and permissions -the user requires to obtain a given NMClientPermission

-
-

Members

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

NM_CLIENT_PERMISSION_RESULT_UNKNOWN

-

unknown or no authorization

-
 

NM_CLIENT_PERMISSION_RESULT_YES

-

the permission is available

-
 

NM_CLIENT_PERMISSION_RESULT_AUTH

-

authorization is necessary before the - permission is available

-
 

NM_CLIENT_PERMISSION_RESULT_NO

-

permission to perform the operation is - denied by system policy

-
 
-
-
-
-

enum NMClientError

Describes errors that may result from operations involving a NMClient.

D-Bus operations may also return errors from other domains, including @@ -5024,7 +5278,7 @@ the user requires to obtain a given

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

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

+failed because NetworkManager is not running

  @@ -5032,9 +5286,9 @@ the user requires to obtain a given

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.

  @@ -5051,6 +5305,6 @@ the user requires to obtain a given -
Generated by GTK-Doc V1.29
+
Generated by GTK-Doc V1.32.1
\ No newline at end of file -- cgit 1.3.0-6-gf8a5