From 1372848511cb896b80b51ed1a3e9606bd9816631 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 10 Feb 2023 11:50:34 +0100 Subject: New upstream version 1.42.0 --- docs/libnm/html/NMClient.html | 311 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 284 insertions(+), 27 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index cb57834b..144c479d 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -167,6 +167,13 @@ +const guint32 * + + +nm_client_get_version_info () + + + NMState @@ -836,6 +843,22 @@ nm_utils_file_is_pkcs12 () + + +void + + +nm_client_wait_shutdown () + + + + +gboolean + + +nm_client_wait_shutdown_finish () + + @@ -1005,6 +1028,12 @@ Read + +GArray * +version-info +Read + + gboolean wimax-enabled Read / Write @@ -1112,6 +1141,10 @@ #define +NM_CLIENT_VERSION_INFO + + +#define NM_CLIENT_STATE @@ -1287,12 +1320,12 @@ NM_CLIENT_ERROR -typedef -NMDnsEntry +  +NMClient   -NMClient +NMDnsEntry @@ -1839,6 +1872,47 @@ nm_client_get_version ( +

nm_client_get_version_info ()

+
const guint32 *
+nm_client_get_version_info (NMClient *client,
+                            gsize *length);
+

If available, the first element in the array is NM_VERSION which +encodes the daemon version as "(major << 16 | minor << 8 | micro)". +The following elements are a bitfield of NMVersionInfoCapabilities +that indicate that the daemon supports a certain capability.

+
+

Parameters

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

client

the NMClient instance

 

length

the number of returned capabilities.

[out]
+
+
+

Returns

+

the +list of capabilities reported by the server or NULL +if the capabilities are unknown.

+

[transfer none][array length=length]

+
+

Since: 1.42

+ +
+

nm_client_get_state ()

NMState
 nm_client_get_state (NMClient *client);
@@ -3235,7 +3309,7 @@ any.

nm_client_activate_connection_async ()

void
 nm_client_activate_connection_async (NMClient *client,
-                                     NMConnection *connection,
+                                     NMConnection *connection,
                                      NMDevice *device,
                                      const char *specific_object,
                                      GCancellable *cancellable,
@@ -3275,7 +3349,7 @@ track the activation to its completion.

 
 
 
connection

-
an NMConnection. 

+
an NMConnection. 

 [allow-none]
 
 
@@ -3364,7 +3438,7 @@ will be set. 

 
void
 nm_client_add_and_activate_connection_async
                                (NMClient *client,
-                                NMConnection *partial,
+                                NMConnection *partial,
                                 NMDevice *device,
                                 const char *specific_object,
                                 GCancellable *cancellable,
@@ -3395,7 +3469,7 @@ track the activation to its completion.

 
 
 
partial

-
an NMConnection to add; the connection may be
+
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
@@ -3450,7 +3524,7 @@ nm_client_add_and_activate_connection_finish
                                 GError **error);

 
Gets the result of a call to nm_client_add_and_activate_connection_async().

 
You can call nm_active_connection_get_connection() on the returned
-NMActiveConnection to find the path of the created NMConnection.

+NMActiveConnection to find the path of the created NMConnection.

 

 
Parameters

 

@@ -3492,7 +3566,7 @@ will be set. 
void
 nm_client_add_and_activate_connection2
                                (NMClient *client,
-                                NMConnection *partial,
+                                NMConnection *partial,
                                 NMDevice *device,
                                 const char *specific_object,
                                 GVariant *options,
@@ -3537,7 +3611,7 @@ by the daemon:

 
 

-
+
+
+
+
+
+
+
+
+
+

 

 
partial
an NMConnection to add; the connection may be
+
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
@@ -3598,7 +3672,7 @@ nm_client_add_and_activate_connection2_finish
                                 GError **error);
 
Gets the result of a call to nm_client_add_and_activate_connection2().

 
You can call nm_active_connection_get_connection() on the returned
-NMActiveConnection to find the path of the created NMConnection.

+NMActiveConnection to find the path of the created NMConnection.

 

 
Parameters

 

@@ -3808,7 +3882,7 @@ nm_client_get_connections (NMClient object and should not be modified.

 
The connections are as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none][element-type NMRemoteConnection]

 
 
@@ -3847,7 +3921,7 @@ nm_client_get_connection_by_id (the remote connection object on success, or NULL if no
 matching object was found.

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 
 
@@ -3886,7 +3960,7 @@ nm_client_get_connection_by_path (the remote connection object on success, or NULL if the object was
 not known

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 
 
@@ -3925,7 +3999,7 @@ nm_client_get_connection_by_uuid (the remote connection object on success, or NULL if the object was
 not known

 
The connection is as received from D-Bus and might not validate according
-to nm_connection_verify(). 

+to nm_connection_verify(). 

 
[transfer none]

 
 
@@ -3934,7 +4008,7 @@ to 
nm_client_add_connection_async ()

 
void
 nm_client_add_connection_async (NMClient *client,
-                                NMConnection *connection,
+                                NMConnection *connection,
                                 gboolean save_to_disk,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
@@ -5361,6 +5435,11 @@ setting LIBNM_CLIENT_DEBUG and uses thereby g_print(). A plain "print()" function in python is not in sync
 with these functions (it implements additional buffering). By
 using nm_utils_print(), the same logging mechanisms can be used.

+
Also, libnm honors LIBNM_CLIENT_DEBUG_FILE environment. If this
+is set to a filename pattern (accepting "p" for the process ID),
+then the debug log is written to that file instead. With output_mode
+
+zero, the same location will be written. Since: 1.44.

 

 
Parameters

 

@@ -5373,8 +5452,10 @@ using 
output_mode

 
+If 0, it uses the same output as internal libnm debug logging
+does. That is, depending on LIBNM_CLIENT_DEBUG's "stdout" flag
+it uses g_print() or g_printerr() and if LIBNM_CLIENT_DEBUG_FILE is
+set, it writes the output to file instead

 
@@ -5481,6 +5562,141 @@ nm_utils_file_is_pkcs12 (const ch
 
 TRUE if the file is PKCS#12, FALSE if it is not

 
 
+

+

+
nm_client_wait_shutdown ()

+
void
+nm_client_wait_shutdown (NMClient *client,
+                         gboolean integrate_maincontext,
+                         GCancellable *cancellable,
+                         GAsyncReadyCallback callback,
+                         gpointer user_data);

+
The way to stop NMClient is by unrefing it. That will cancel all
+internally pending async operations. However, as async operations in
+NMClient use GTask, hence they cannot complete right away. Instead,
+their (internal) result callback still needs to be dispatched by iterating
+the client's main context.

+
You thus cannot stop iterating the client's main context until
+everything is wrapped up. nm_client_get_context_busy_watcher()
+helps to watch how long that will be.

+
This function automates that waiting. Like all glib async operations
+this honors the current g_main_context_get_thread_default().

+
In any case, to complete the shutdown, nm_client_get_main_context()
+must be iterated. If the current g_main_context_get_thread_default() is
+the same as nm_client_get_main_context(), then integrate_maincontext
+
+is ignored. In that case, the caller is required to iterate the context
+for shutdown to complete. Otherwise, if g_main_context_get_thread_default()
+differs from nm_client_get_main_context() and integrate_maincontext
+
+is FALSE, the caller must make sure that both contexts are iterated
+until completion. Otherwise, if integrate_maincontext
+ is TRUE, then
+nm_client_get_main_context() will be integrated in g_main_context_get_thread_default().
+This means, the caller gives nm_client_get_main_context() up until the waiting
+completes, the function will acquire the context and hook it into
+g_main_context_get_thread_default().
+It is a bug to request integrate_maincontext
+ while having nm_client_get_main_context()
+acquired or iterated otherwise because a context can only be acquired once
+at a time.

+
Shutdown can only complete after all references to client
+ were released.

+
It is possible to call this function multiple times for the same client.
+But note that with integrate_maincontext
+ the client's context is acquired,
+which can only be done once at a time.

+
It is permissible to start waiting before the objects is fully initialized.

+
The function really allows two separate things. To get a notification (callback) when
+shutdown is complete, and to integrate the client's context in another context.
+The latter case is useful if the client has a separate context and you hand it
+over to another GMainContext to wrap up.

+
The main use is to have a NMClient and a separate GMainContext on a worker
+thread. When being done, you can hand over the cleanup of the context
+to g_main_context_default(), assuming that the main thread iterates
+the default context. In that case, you don't need to care about passing
+a callback to know when shutdown completed.

+

+
Parameters

+
if 1 it uses g_print(). If 2, it uses g_printerr().
-If 0, it uses either g_print() or g_printerr(), depending
-on LIBNM_CLIENT_DEBUG (and the "stdout" flag).
 
 

 

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





client
the NMClient to shutdown.
 
integrate_maincontext
whether to hook the client's maincontext
+in the current thread default. Otherwise, you must ensure
+that the client's maincontext gets iterated so that it can complete.
+By integrating the maincontext in the current thread default, you
+may instead only iterate the latter.
 
cancellable
the GCancellable to abort the shutdown. 
[allow-none]
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.42

+
+

+

+
nm_client_wait_shutdown_finish ()

+
gboolean
+nm_client_wait_shutdown_finish (GAsyncResult *result,
+                                GError **error);

+

+
Parameters

+

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





result
a GAsyncResult obtained from the GAsyncReadyCallback passed to nm_client_wait_shutdown()
 
error
return location for error or NULL
 

+

+

+
Returns

+
 TRUE if waiting is complete successfully. In that case, all resources of the
+nmclient are wrapped up and released. This can only fail by user cancellation.

+

+
Since: 1.42

+

 
 

 
Types and Values

@@ -5514,6 +5730,26 @@ to know whether the permissions are up to date.

 

  
 
NM_CLIENT_INSTANCE_FLAGS_INITIALIZED_GOOD

+
as NMClient is an GInitable
+and GAsyncInitable, nm_client_get_instance_flags() returns this flag
+once initialization completed with success. This flag cannot be set
+as NM_CLIENT_INSTANCE_FLAGS property. Since: 1.42.

+		 
NM_CLIENT_INSTANCE_FLAGS_INITIALIZED_BAD

+
like NM_CLIENT_INSTANCE_FLAGS_INITIALIZED_GOOD
+
+indicates that the instance completed initialization with failure. In that
+case the instance is unusable. Since: 1.42.

+		 

 
 

 

@@ -5527,6 +5763,12 @@ to know whether the permissions are up to date.
+

NM_CLIENT_VERSION_INFO

+
#define NM_CLIENT_VERSION_INFO    "version-info"
+
+
+
+

NM_CLIENT_STATE

#define NM_CLIENT_STATE           "state"
@@ -5834,13 +6076,6 @@ operation succeeded, but the object that was allegedly created (eg,
-

NMDnsEntry

-
typedef struct NMDnsEntry NMDnsEntry;
-
-

Since: 1.6

-
-
-

NMClient

typedef struct _NMClient NMClient;

NMClient contains a cache of the objects of NetworkManager's D-Bus API. @@ -5849,6 +6084,12 @@ D-Bus signals. That means, when iterating the associated NMClient instance updates and emits GObject signals.

+
+
+

NMDnsEntry

+
typedef struct _NMDnsEntry NMDnsEntry;
+

Since: 1.6

+

Property Details

@@ -6039,6 +6280,8 @@ construction.

even after constructing the instance. Note that you may want to watch NMClient:permissions-state property to know whether permissions are ready. Note that permissions are only fetched when NMClient has a D-Bus name owner.

+

The flags NM_CLIENT_INSTANCE_FLAGS_INITIALIZED_GOOD and NM_CLIENT_INSTANCE_FLAGS_INITIALIZED_BAD +cannot be set, however they will be returned by the getter after initialization completes.

Owner: NMClient

Flags: Read / Write / Construct

Default value: 0

@@ -6143,6 +6386,20 @@ see
+

The “version-info” property

+
  “version-info”             GArray *
+

Expose version info and capabilities of NetworkManager. If non-empty, +the first element is NM_VERSION, which encodes the version of the +daemon as "(major << 16 | minor << 8 | micro)". The following elements +is a bitfields of NMVersionInfoCapabilities. If a bit is set, then +the running NetworkManager has the respective capability.

+

[type GArray(guint32)]

+

Owner: NMClient

+

Flags: Read

+

Since: 1.42

+
+
+

The “wimax-enabled” property

  “wimax-enabled”            gboolean

Whether WiMAX functionality is enabled.

@@ -6364,7 +6621,7 @@ regular devices and placeholder devices.

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

Notifies that a NMConnection has been added.

+

Notifies that a NMConnection has been added.

Parameters

@@ -6401,7 +6658,7 @@ user_function (NMClient *client, NMRemoteConnection *connection, gpointer user_data) -

Notifies that a NMConnection has been removed.

+

Notifies that a NMConnection has been removed.

Parameters

-- cgit 1.3.0-6-gf8a5