From 0018d1f3cf71d680d7b6bceda55a5717244d8b26 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 16 Aug 2022 18:24:19 +0200 Subject: New upstream version 1.39.90 --- docs/libnm/html/NMClient.html | 991 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 986 insertions(+), 5 deletions(-) (limited to 'docs/libnm/html/NMClient.html') diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index f74bf1f3..82cf2677 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -16,7 +16,10 @@ Top  |  Description  |  - Object Hierarchy + Object Hierarchy  |  + Implemented Interfaces  |  + Properties  |  + Signals Home Up @@ -836,6 +839,261 @@ +
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+NMActiveConnection *activating-connectionRead
+GPtrArray *active-connectionsRead
+GPtrArray *all-devicesRead
gbooleancan-modifyRead
+GArray *capabilitiesRead
+GPtrArray *checkpointsRead
+GPtrArray *connectionsRead
NMConnectivityStateconnectivityRead
gbooleanconnectivity-check-availableRead
gbooleanconnectivity-check-enabledRead / Write
+char *connectivity-check-uriRead
+GDBusConnection *dbus-connectionRead / Write / Construct Only
+char *dbus-name-ownerRead
+GPtrArray *devicesRead
+GPtrArray *dns-configurationRead
+char *dns-modeRead
+char *dns-rc-managerRead
+char *hostnameRead
guintinstance-flagsRead / Write / Construct
guintmeteredRead
gbooleannetworking-enabledRead / Write
gbooleannm-runningRead
NMTernarypermissions-stateRead
+NMActiveConnection *primary-connectionRead
guintradio-flagsRead
gbooleanstartupRead
NMStatestateRead
+char *versionRead
gbooleanwimax-enabledRead / Write
gbooleanwimax-hardware-enabledRead
gbooleanwireless-enabledRead / Write
gbooleanwireless-hardware-enabledRead
gbooleanwwan-enabledRead / Write
gbooleanwwan-hardware-enabledRead
+
+
+

Signals

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
voidactive-connection-addedRun First
voidactive-connection-removedRun First
voidany-device-addedRun First
voidany-device-removedRun First
voidconnection-addedRun First
voidconnection-removedRun First
voiddevice-addedRun First
voiddevice-removedRun First
voidpermission-changedRun First
+

Types and Values

@@ -1028,6 +1286,10 @@ + + + +
#define NM_CLIENT_ERROR
 NMClient
@@ -1039,9 +1301,17 @@ ╰── NMClientError GFlags ╰── NMClientInstanceFlags + GObject + ╰── NMClient
+

Implemented Interfaces

+

+NMClient implements + GInitable and GAsyncInitable.

+
+

Description

@@ -2933,7 +3203,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

@@ -2983,7 +3253,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

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

Parameters

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

This is identical to nm_client_add_and_activate_connection_async() but takes a further options @@ -5557,6 +5827,717 @@ operation succeeded, but the object that was allegedly created (eg, 

#define NM_CLIENT_ERROR nm_client_error_quark()
+
+
+

NMClient

+
typedef struct _NMClient NMClient;
+

NMClient contains a cache of the objects of NetworkManager's D-Bus API. +It uses GMainContext and GDBusConnection for that and registers to +D-Bus signals. That means, when iterating the associated GMainContext, +D-Bus signals gets processed and the NMClient instance updates and +emits GObject signals.

+
+
+
+

Property Details

+
+

The “activating-connection” property

+
  “activating-connection”    NMActiveConnection *
+

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

+

Owner: NMClient

+

Flags: Read

+
+
+
+

The “active-connections” property

+
  “active-connections”       GPtrArray *
+

The active connections.

+

[type GPtrArray(NMActiveConnection)]

+

Owner: NMClient

+

Flags: Read

+
+
+
+

The “all-devices” property

+
  “all-devices”              GPtrArray *
+

List of both real devices and device placeholders.

+

[type GPtrArray(NMDevice)]

+

Owner: NMClient

+

Flags: Read

+

Since: 1.2

+
+
+
+

The “can-modify” property

+
  “can-modify”               gboolean
+

If TRUE, adding and modifying connections is supported.

+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “capabilities” property

+
  “capabilities”             GArray *
+

The list of capabilities numbers as guint32 or NULL if +there are no capabilities. The numeric value correspond +to NMCapability enum.

+

[type GArray(guint32)]

+

Owner: NMClient

+

Flags: Read

+

Since: 1.24

+
+
+
+

The “checkpoints” property

+
  “checkpoints”              GPtrArray *
+

The list of active checkpoints.

+

[type GPtrArray(NMCheckpoint)]

+

Owner: NMClient

+

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)]

+

Owner: NMClient

+

Flags: Read

+
+
+
+

The “connectivity” property

+
  “connectivity”             NMConnectivityState
+

The network connectivity state.

+

Owner: NMClient

+

Flags: Read

+

Default value: NM_CONNECTIVITY_UNKNOWN

+
+
+
+

The “connectivity-check-available” property

+
  “connectivity-check-available” gboolean
+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “connectivity-check-enabled” property

+
  “connectivity-check-enabled” gboolean
+

Owner: NMClient

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “connectivity-check-uri” property

+
  “connectivity-check-uri”   char *
+

The used URI for connectivity checking.

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+

Since: 1.22

+
+
+
+

The “dbus-connection” property

+
  “dbus-connection”          GDBusConnection *
+

The GDBusConnection to use.

+

If this is not set during object construction, the D-Bus connection will +automatically be chosen during async/sync initalization via g_bus_get().

+

Owner: NMClient

+

Flags: Read / Write / Construct Only

+

Since: 1.22

+
+
+
+

The “dbus-name-owner” property

+
  “dbus-name-owner”          char *
+

The name owner of the NetworkManager D-Bus service.

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+

Since: 1.22

+
+
+
+

The “devices” property

+
  “devices”                  GPtrArray *
+

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

+

[type GPtrArray(NMDevice)]

+

Owner: NMClient

+

Flags: Read

+
+
+
+

The “dns-configuration” property

+
  “dns-configuration”        GPtrArray *
+

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

+

[type GPtrArray(NMDnsEntry)]

+

Owner: NMClient

+

Flags: Read

+

Since: 1.6

+
+
+
+

The “dns-mode” property

+
  “dns-mode”                 char *
+

The current DNS processing mode.

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+

Since: 1.6

+
+
+
+

The “dns-rc-manager” property

+
  “dns-rc-manager”           char *
+

The current resolv.conf management mode.

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+

Since: 1.6

+
+
+
+

The “hostname” property

+
  “hostname”                 char *
+

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

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “instance-flags” property

+
  “instance-flags”           guint
+

NMClientInstanceFlags for the instance. These affect behavior of NMClient. +This is a construct property and you may only set most flags only during +construction.

+

The flag NM_CLIENT_INSTANCE_FLAGS_NO_AUTO_FETCH_PERMISSIONS can be toggled any time, +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.

+

Owner: NMClient

+

Flags: Read / Write / Construct

+

Default value: 0

+

Since: 1.24

+
+
+
+

The “metered” property

+
  “metered”                  guint
+

Whether the connectivity is metered.

+

Owner: NMClient

+

Flags: Read

+

Default value: 0

+

Since: 1.2

+
+
+
+

The “networking-enabled” property

+
  “networking-enabled”       gboolean
+

Whether networking is enabled.

+

The property setter is a synchronous D-Bus call. This is deprecated since 1.22.

+

Owner: NMClient

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “nm-running” property

+
  “nm-running”               gboolean
+

Whether the daemon is running.

+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “permissions-state” property

+
  “permissions-state”        NMTernary
+

The state of the cached permissions. The value NM_TERNARY_DEFAULT +means that no permissions are yet received (or not yet requested). +NM_TERNARY_TRUE means that permissions are received, cached and up +to date. NM_TERNARY_FALSE means that permissions were received and are +cached, but in the meantime a "CheckPermissions" signal was received +that invalidated the cached permissions. +Note that NMClient will always emit a notify::permissions-state signal +when a "CheckPermissions" signal got received or after new permissions +got received (that is regardless whether the value of the permission state +actually changed). With this you can watch the permissions-state property +to know whether the permissions are ready. Note that while NMClient has +no D-Bus name owner, no permissions are fetched (and this property won't +change).

+

Owner: NMClient

+

Flags: Read

+

Default value: NM_TERNARY_DEFAULT

+

Since: 1.24

+
+
+
+

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.

+

Owner: NMClient

+

Flags: Read

+
+
+
+

The “radio-flags” property

+
  “radio-flags”              guint
+

Flags for radio interfaces. See NMRadioFlags.

+

Owner: NMClient

+

Flags: Read

+

Default value: 0

+

Since: 1.38

+
+
+
+

The “startup” property

+
  “startup”                  gboolean
+

Whether the daemon is still starting up.

+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “state” property

+
  “state”                    NMState
+

The current daemon state.

+

Owner: NMClient

+

Flags: Read

+

Default value: NM_STATE_UNKNOWN

+
+
+
+

The “version” property

+
  “version”                  char *
+

The NetworkManager version.

+

Owner: NMClient

+

Flags: Read

+

Default value: NULL

+
+
+
+

The “wimax-enabled” property

+
  “wimax-enabled”            gboolean
+

Whether WiMAX functionality is enabled.

+
+

NMClient:wimax-enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

WiMAX is no longer supported and this always returns FALSE. The setter has no effect.

+
+

Owner: NMClient

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “wimax-hardware-enabled” property

+
  “wimax-hardware-enabled”   gboolean
+

Whether the WiMAX hardware is enabled.

+
+

NMClient:wimax-hardware-enabled has been deprecated since version 1.22 and should not be used in newly-written code.

+

WiMAX is no longer supported and this always returns FALSE.

+
+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “wireless-enabled” property

+
  “wireless-enabled”         gboolean
+

Whether wireless is enabled.

+

The property setter is a synchronous D-Bus call. This is deprecated since 1.22.

+

Owner: NMClient

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “wireless-hardware-enabled” property

+
  “wireless-hardware-enabled” gboolean
+

Whether the wireless hardware is enabled.

+

Owner: NMClient

+

Flags: Read

+

Default value: FALSE

+
+
+
+

The “wwan-enabled” property

+
  “wwan-enabled”             gboolean
+

Whether WWAN functionality is enabled.

+

The property setter is a synchronous D-Bus call. This is deprecated since 1.22.

+

Owner: NMClient

+

Flags: Read / Write

+

Default value: FALSE

+
+
+
+

The “wwan-hardware-enabled” property

+
  “wwan-hardware-enabled”    gboolean
+

Whether the WWAN hardware is enabled.

+

Owner: NMClient

+

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 client 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 client 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 client 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 client 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

+
-- cgit 1.3.0-6-gf8a5