From 2e5fa45ddfbb5cffa1e78221f1cea706e2f298af Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 31 Jul 2019 10:51:42 +0200 Subject: New upstream version 1.19.90 --- docs/libnm-glib/html/NMClient.html | 2567 ------------------------------------ 1 file changed, 2567 deletions(-) delete mode 100644 docs/libnm-glib/html/NMClient.html (limited to 'docs/libnm-glib/html/NMClient.html') diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html deleted file mode 100644 index e5532f16..00000000 --- a/docs/libnm-glib/html/NMClient.html +++ /dev/null @@ -1,2567 +0,0 @@ - - - - -NMClient: libnm-glib Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NMClient

-

NMClient

-
-
-

Functions

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-GQuark - -nm_client_error_quark () -
-NMClient * - -nm_client_new () -
-void - -nm_client_new_async () -
-NMClient * - -nm_client_new_finish () -
const GPtrArray * - -nm_client_get_devices () -
const GPtrArray * - -nm_client_get_all_devices () -
-NMDevice * - -nm_client_get_device_by_path () -
-NMDevice * - -nm_client_get_device_by_iface () -
-void - -(*NMClientActivateFn) () -
-void - -nm_client_activate_connection () -
-void - -(*NMClientAddActivateFn) () -
-void - -nm_client_add_and_activate_connection () -
-void - -nm_client_deactivate_connection () -
-gboolean - -nm_client_networking_get_enabled () -
-void - -nm_client_networking_set_enabled () -
-gboolean - -nm_client_wireless_get_enabled () -
-void - -nm_client_wireless_set_enabled () -
-gboolean - -nm_client_wireless_hardware_get_enabled () -
-gboolean - -nm_client_wwan_get_enabled () -
-void - -nm_client_wwan_set_enabled () -
-gboolean - -nm_client_wwan_hardware_get_enabled () -
-gboolean - -nm_client_wimax_get_enabled () -
-void - -nm_client_wimax_set_enabled () -
-gboolean - -nm_client_wimax_hardware_get_enabled () -
const char * - -nm_client_get_version () -
-NMState - -nm_client_get_state () -
-gboolean - -nm_client_get_startup () -
-gboolean - -nm_client_get_manager_running () -
const GPtrArray * - -nm_client_get_active_connections () -
-void - -nm_client_sleep () -
-NMClientPermissionResult - -nm_client_get_permission_result () -
-gboolean - -nm_client_get_logging () -
-gboolean - -nm_client_set_logging () -
-NMConnectivityState - -nm_client_get_connectivity () -
-NMConnectivityState - -nm_client_check_connectivity () -
-void - -nm_client_check_connectivity_async () -
-NMConnectivityState - -nm_client_check_connectivity_finish () -
-NMActiveConnection * - -nm_client_get_primary_connection () -
-NMActiveConnection * - -nm_client_get_activating_connection () -
-
-
-

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-NMActiveConnection *activating-connectionRead
-NMObjectArray *active-connectionsRead
-NMObjectArray *all-devicesRead
guintconnectivityRead
-NMObjectArray *devicesRead
gbooleanmanager-runningRead
gbooleannetworking-enabledRead / Write
-NMActiveConnection *primary-connectionRead
gbooleanstartupRead
guintstateRead
-gchar *versionRead
gbooleanwimax-enabledRead / Write
gbooleanwimax-hardware-enabledRead
gbooleanwireless-enabledRead / Write
gbooleanwireless-hardware-enabledRead
gbooleanwwan-enabledRead / Write
gbooleanwwan-hardware-enabledRead
-
-
-

Signals

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - -
voidany-device-addedRun First
voidany-device-removedRun First
voiddevice-addedRun First
voiddevice-removedRun First
voidpermission-changedRun First
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_CLIENT_VERSION
#defineNM_CLIENT_STATE
#defineNM_CLIENT_STARTUP
#defineNM_CLIENT_MANAGER_RUNNING
#defineNM_CLIENT_NETWORKING_ENABLED
#defineNM_CLIENT_WIRELESS_ENABLED
#defineNM_CLIENT_WIRELESS_HARDWARE_ENABLED
#defineNM_CLIENT_WWAN_ENABLED
#defineNM_CLIENT_WWAN_HARDWARE_ENABLED
#defineNM_CLIENT_WIMAX_ENABLED
#defineNM_CLIENT_WIMAX_HARDWARE_ENABLED
#defineNM_CLIENT_ACTIVE_CONNECTIONS
#defineNM_CLIENT_CONNECTIVITY
#defineNM_CLIENT_PRIMARY_CONNECTION
#defineNM_CLIENT_ACTIVATING_CONNECTION
#defineNM_CLIENT_DEVICES
#defineNM_CLIENT_ALL_DEVICES
enumNMClientPermission
enumNMClientPermissionResult
enumNMClientError
#defineNM_CLIENT_ERROR
-
-
-

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMClient
-
-
-
-

Description

-
-
-

Functions

-
-

nm_client_error_quark ()

-
GQuark
-nm_client_error_quark (void);
-

Registers an error quark for NMClient if necessary.

-
-

Returns

-

the error quark used for NMClient errors.

-
-

Since: 0.9.10

-
-
-
-

nm_client_new ()

-
NMClient *
-nm_client_new (void);
-

Creates a new NMClient.

-

Note that this will do blocking D-Bus calls to initialize the -client. You can use nm_client_new_async() if you want to avoid -that.

-

NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object.

-
-

Returns

-

a new NMClient or NULL on an error

-
-
-
-
-

nm_client_new_async ()

-
void
-nm_client_new_async (GCancellable *cancellable,
-                     GAsyncReadyCallback callback,
-                     gpointer user_data);
-

Creates a new NMClient and begins asynchronously initializing it. -callback - will be called when it is done; use -nm_client_new_finish() to get the result. Note that on an error, -the callback can be invoked with two first parameters as NULL.

-

NOTE: NMClient provides information about devices and a mechanism to -control them. To access and modify network configuration data, use the -NMRemoteSettings object.

-
-

Parameters

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

cancellable

a GCancellable, or NULL

 

callback

callback to call when the client is created

 

user_data

data for callback -

 
-
-
-
-
-

nm_client_new_finish ()

-
NMClient *
-nm_client_new_finish (GAsyncResult *result,
-                      GError **error);
-

Gets the result of an nm_client_new_async() call.

-
-

Parameters

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

result

a GAsyncResult

 

error

location for a GError, or NULL

 
-
-
-

Returns

-

a new NMClient, or NULL on error

-
-
-
-
-

nm_client_get_devices ()

-
const GPtrArray *
-nm_client_get_devices (NMClient *client);
-

Gets all the known network devices. Use nm_device_get_type() or the -NM_IS_DEVICE_XXXX functions to determine what kind of -device member of the returned array is, and then you may use device-specific -methods such as nm_device_ethernet_get_hw_address().

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

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]

-
-
-
-
-

nm_client_get_all_devices ()

-
const GPtrArray *
-nm_client_get_all_devices (NMClient *client);
-

Gets both real devices and device placeholders (eg, software devices which -do not currently exist, but could be created automatically by NetworkManager -if one of their NMDevice::ActivatableConnections was activated). Use -nm_device_is_real() to determine whether each device is a real device or -a placeholder.

-

Use nm_device_get_type() or the NM_IS_DEVICE_XXXX() functions to determine -what kind of device each member of the returned array is, and then you may -use device-specific methods such as nm_device_ethernet_get_hw_address().

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

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]

-
-

Since: 1.2

-
-
-
-

nm_client_get_device_by_path ()

-
NMDevice *
-nm_client_get_device_by_path (NMClient *client,
-                              const char *object_path);
-

Gets a NMDevice from a NMClient.

-
-

Parameters

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

client

a NMClient

 

object_path

the object path to search for

 
-
-
-

Returns

-

the NMDevice for the given object_path -or NULL if none is found.

-

[transfer none]

-
-
-
-
-

nm_client_get_device_by_iface ()

-
NMDevice *
-nm_client_get_device_by_iface (NMClient *client,
-                               const char *iface);
-

Gets a NMDevice from a NMClient.

-
-

Parameters

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

client

a NMClient

 

iface

the interface name to search for

 
-
-
-

Returns

-

the NMDevice for the given iface -or NULL if none is found.

-

[transfer none]

-
-
-
-
-

NMClientActivateFn ()

-
void
-(*NMClientActivateFn) (NMClient *client,
-                       NMActiveConnection *active_connection,
-                       GError *error,
-                       gpointer user_data);
-
-
-
-

nm_client_activate_connection ()

-
void
-nm_client_activate_connection (NMClient *client,
-                               NMConnection *connection,
-                               NMDevice *device,
-                               const char *specific_object,
-                               NMClientActivateFn callback,
-                               gpointer user_data);
-

Starts a connection to a particular network using the configuration settings -from connection - and the network device device -. Certain connection types -also take a "specific object" which is the object path of a connection- -specific object, like an NMAccessPoint for Wi-Fi connections, or an -NMWimaxNsp for WiMAX connections, to which you wish to connect. If the -specific object is not given, NetworkManager can, in some cases, automatically -determine which network to connect to given the settings in connection -.

-

If connection - is not given for a device-based activation, NetworkManager -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 used the returned -NMActiveConnection object (in particular, “state”) to -track the activation to its completion.

-
-

Parameters

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

client

a NMClient

 

connection

an NMConnection.

[allow-none]

device

the NMDevice.

[allow-none]

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 -(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 -get using nm_object_get_path(), and which will be used to complete the -details of the newly added connection.

[allow-none]

callback

the function to call when the call is done.

[scope async][allow-none]

user_data

user data to pass to the callback function.

[closure]
-
-
-
-
-

NMClientAddActivateFn ()

-
void
-(*NMClientAddActivateFn) (NMClient *client,
-                          NMActiveConnection *connection,
-                          const char *new_connection_path,
-                          GError *error,
-                          gpointer user_data);
-
-
-
-

nm_client_add_and_activate_connection ()

-
void
-nm_client_add_and_activate_connection (NMClient *client,
-                                       NMConnection *partial,
-                                       NMDevice *device,
-                                       const char *specific_object,
-                                       NMClientAddActivateFn callback,
-                                       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. -Cannot be used for VPN connections at this time.

-

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

-
-

Parameters

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

client

a NMClient

 

partial

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.

[allow-none]

device

the NMDevice

 

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 -(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 -get using nm_object_get_path(), and which will be used to complete the -details of the newly added connection.

[allow-none]

callback

the function to call when the call is done.

[scope async][allow-none]

user_data

user data to pass to the callback function.

[closure]
-
-
-
-
-

nm_client_deactivate_connection ()

-
void
-nm_client_deactivate_connection (NMClient *client,
-                                 NMActiveConnection *active);
-

Deactivates an active NMActiveConnection.

-
-

Parameters

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

client

a NMClient

 

active

the NMActiveConnection to deactivate

 
-
-
-
-
-

nm_client_networking_get_enabled ()

-
gboolean
-nm_client_networking_get_enabled (NMClient *client);
-

Whether networking is enabled or disabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if networking is enabled, FALSE if networking is disabled

-
-
-
-
-

nm_client_networking_set_enabled ()

-
void
-nm_client_networking_set_enabled (NMClient *client,
-                                  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.

-
-

Parameters

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

client

a NMClient

 

enabled

TRUE to set networking enabled, FALSE to set networking disabled

 
-
-
-
-
-

nm_client_wireless_get_enabled ()

-
gboolean
-nm_client_wireless_get_enabled (NMClient *client);
-

Determines whether the wireless is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if wireless is enabled

-
-
-
-
-

nm_client_wireless_set_enabled ()

-
void
-nm_client_wireless_set_enabled (NMClient *client,
-                                gboolean enabled);
-

Enables or disables wireless devices.

-
-

Parameters

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

client

a NMClient

 

enabled

TRUE to enable wireless

 
-
-
-
-
-

nm_client_wireless_hardware_get_enabled ()

-
gboolean
-nm_client_wireless_hardware_get_enabled
-                               (NMClient *client);
-

Determines whether the wireless hardware is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if the wireless hardware is enabled

-
-
-
-
-

nm_client_wwan_get_enabled ()

-
gboolean
-nm_client_wwan_get_enabled (NMClient *client);
-

Determines whether WWAN is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if WWAN is enabled

-
-
-
-
-

nm_client_wwan_set_enabled ()

-
void
-nm_client_wwan_set_enabled (NMClient *client,
-                            gboolean enabled);
-

Enables or disables WWAN devices.

-
-

Parameters

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

client

a NMClient

 

enabled

TRUE to enable WWAN

 
-
-
-
-
-

nm_client_wwan_hardware_get_enabled ()

-
gboolean
-nm_client_wwan_hardware_get_enabled (NMClient *client);
-

Determines whether the WWAN hardware is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if the WWAN hardware is enabled

-
-
-
-
-

nm_client_wimax_get_enabled ()

-
gboolean
-nm_client_wimax_get_enabled (NMClient *client);
-

Determines whether WiMAX is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if WiMAX is enabled

-
-
-
-
-

nm_client_wimax_set_enabled ()

-
void
-nm_client_wimax_set_enabled (NMClient *client,
-                             gboolean enabled);
-

Enables or disables WiMAX devices.

-
-

Parameters

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

client

a NMClient

 

enabled

TRUE to enable WiMAX

 
-
-
-
-
-

nm_client_wimax_hardware_get_enabled ()

-
gboolean
-nm_client_wimax_hardware_get_enabled (NMClient *client);
-

Determines whether the WiMAX hardware is enabled.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if the WiMAX hardware is enabled

-
-
-
-
-

nm_client_get_version ()

-
const char *
-nm_client_get_version (NMClient *client);
-

Gets NetworkManager version.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

string with the version

-
-
-
-
-

nm_client_get_state ()

-
NMState
-nm_client_get_state (NMClient *client);
-

Gets the current daemon state.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

the current NMState

-
-
-
-
-

nm_client_get_startup ()

-
gboolean
-nm_client_get_startup (NMClient *client);
-

Tests whether the daemon is still in the process of activating -connections at startup.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

whether the daemon is still starting up

-
-

Since: 0.9.10

-
-
-
-

nm_client_get_manager_running ()

-
gboolean
-nm_client_get_manager_running (NMClient *client);
-

Determines whether the daemon is running.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

TRUE if the daemon is running

-
-
-
-
-

nm_client_get_active_connections ()

-
const GPtrArray *
-nm_client_get_active_connections (NMClient *client);
-

Gets the active connections.

-
-

Parameters

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

client

a NMClient

 
-
-
-

Returns

-

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]

-
-
-
-
-

nm_client_sleep ()

-
void
-nm_client_sleep (NMClient *client,
-                 gboolean sleep_);
-

Deprecated; use nm_client_networking_set_enabled() instead.

-
-

Parameters

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

client

a NMClient

 

sleep_

TRUE to put the daemon to sleep

 
-
-
-
-
-

nm_client_get_permission_result ()

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

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

-
-

Parameters

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

client

a NMClient

 

permission

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

 
-
-
-

Returns

-

the permission's result, one of NMClientPermissionResult

-
-
-
-
-

nm_client_get_logging ()

-
gboolean
-nm_client_get_logging (NMClient *client,
-                       char **level,
-                       char **domains,
-                       GError **error);
-

Gets NetworkManager current logging level and domains.

-
-

Parameters

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

client

a NMClient

 

level

return location for logging level string.

[allow-none]

domains

return location for log domains string. The string is -a list of domains separated by ",".

[allow-none]

error

return location for a GError, or NULL.

[allow-none]
-
-
-

Returns

-

TRUE on success, FALSE otherwise

-
-

Since: 0.9.8

-
-
-
-

nm_client_set_logging ()

-
gboolean
-nm_client_set_logging (NMClient *client,
-                       const char *level,
-                       const char *domains,
-                       GError **error);
-

Sets NetworkManager logging level and/or domains.

-
-

Parameters

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

client

a NMClient

 

level

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

[allow-none]

error

return location for a GError, or NULL.

[allow-none]
-
-
-

Returns

-

TRUE on success, FALSE otherwise

-
-

Since: 0.9.8

-
-
-
-

nm_client_get_connectivity ()

-
NMConnectivityState
-nm_client_get_connectivity (NMClient *client);
-

Gets the current network connectivity state. Contrast -nm_client_check_connectivity() and -nm_client_check_connectivity_async(), which re-check the -connectivity state first before returning any information.

-
-

Parameters

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

client

an NMClient

 
-
-
-

Returns

-

the current connectivity state

-
-

Since: 0.9.8.6

-
-
-
-

nm_client_check_connectivity ()

-
NMConnectivityState
-nm_client_check_connectivity (NMClient *client,
-                              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.

-

This is a blocking call; use nm_client_check_connectivity_async() -if you do not want to block.

-
-

Parameters

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

client

an NMClient

 

cancellable

a GCancellable

 

error

return location for a GError

 
-
-
-

Returns

-

the (new) current connectivity state

-
-

Since: 0.9.8.6

-
-
-
-

nm_client_check_connectivity_async ()

-
void
-nm_client_check_connectivity_async (NMClient *client,
-                                    GCancellable *cancellable,
-                                    GAsyncReadyCallback callback,
-                                    gpointer user_data);
-

Asynchronously updates the network connectivity state and invokes -callback - when complete. Contrast nm_client_get_connectivity(), -which (immediately) returns the most recent known state without -re-checking, and nm_client_check_connectivity(), which blocks.

-
-

Parameters

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

client

an NMClient

 

cancellable

a GCancellable

 

callback

callback to call with the result

 

user_data

data for callback -.

 
-
-

Since: 0.9.8.6

-
-
-
-

nm_client_check_connectivity_finish ()

-
NMConnectivityState
-nm_client_check_connectivity_finish (NMClient *client,
-                                     GAsyncResult *result,
-                                     GError **error);
-

Retrieves the result of an nm_client_check_connectivity_async() -call.

-
-

Parameters

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

client

an NMClient

 

result

the GAsyncResult

 

error

return location for a GError

 
-
-
-

Returns

-

the (new) current connectivity state

-
-

Since: 0.9.8.6

-
-
-
-

nm_client_get_primary_connection ()

-
NMActiveConnection *
-nm_client_get_primary_connection (NMClient *client);
-

Gets the NMActiveConnection corresponding to the primary active -network device.

-

In particular, when there is no VPN active, or the VPN does not -have the default route, this returns the active connection that has -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.

-
-

Parameters

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

client

an NMClient

 
-
-
-

Returns

-

the appropriate NMActiveConnection, if -any.

-

[transfer none]

-
-

Since: 0.9.8.6

-
-
-
-

nm_client_get_activating_connection ()

-
NMActiveConnection *
-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.

-
-

Parameters

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

client

an NMClient

 
-
-
-

Returns

-

the appropriate NMActiveConnection, if -any.

-

[transfer none]

-
-

Since: 0.9.8.6

-
-
-
-

Types and Values

-
-

NM_CLIENT_VERSION

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

NM_CLIENT_STATE

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

NM_CLIENT_STARTUP

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

NM_CLIENT_MANAGER_RUNNING

-
#define NM_CLIENT_MANAGER_RUNNING "manager-running"
-
-
-
-
-

NM_CLIENT_NETWORKING_ENABLED

-
#define NM_CLIENT_NETWORKING_ENABLED "networking-enabled"
-
-
-
-
-

NM_CLIENT_WIRELESS_ENABLED

-
#define NM_CLIENT_WIRELESS_ENABLED "wireless-enabled"
-
-
-
-
-

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_HARDWARE_ENABLED

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

NM_CLIENT_WIMAX_ENABLED

-
#define NM_CLIENT_WIMAX_ENABLED "wimax-enabled"
-
-
-
-
-

NM_CLIENT_WIMAX_HARDWARE_ENABLED

-
#define NM_CLIENT_WIMAX_HARDWARE_ENABLED "wimax-hardware-enabled"
-
-
-
-
-

NM_CLIENT_ACTIVE_CONNECTIONS

-
#define NM_CLIENT_ACTIVE_CONNECTIONS "active-connections"
-
-
-
-
-

NM_CLIENT_CONNECTIVITY

-
#define NM_CLIENT_CONNECTIVITY "connectivity"
-
-
-
-
-

NM_CLIENT_PRIMARY_CONNECTION

-
#define NM_CLIENT_PRIMARY_CONNECTION "primary-connection"
-
-
-
-
-

NM_CLIENT_ACTIVATING_CONNECTION

-
#define NM_CLIENT_ACTIVATING_CONNECTION "activating-connection"
-
-
-
-
-

NM_CLIENT_DEVICES

-
#define NM_CLIENT_DEVICES "devices"
-
-
-
-
-

NM_CLIENT_ALL_DEVICES

-
#define NM_CLIENT_ALL_DEVICES "all-devices"
-
-
-
-
-

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. - persistent hostname can be changed

-		 

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_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.

-
-

Members

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

NM_CLIENT_ERROR_UNKNOWN

 -

unknown or unclassified error

-		 

NM_CLIENT_ERROR_MANAGER_NOT_RUNNING

 -

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

-		 
-
-
-
-
-

NM_CLIENT_ERROR

-
#define NM_CLIENT_ERROR nm_client_error_quark ()
-
-
-
-
-

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

-

Since: 0.9.8.6

-
-
-
-

The “active-connections” property

-
  “active-connections”       NMObjectArray *
-

Flags: Read

-
-
-
-

The “all-devices” property

-
  “all-devices”              NMObjectArray *
-

List of both real devices and device placeholders.

-

Flags: Read

-

Since: 1.2

-
-
-
-

The “connectivity” property

-
  “connectivity”             guint
-

The network connectivity state.

-

Flags: Read

-

Allowed values: <= 4

-

Default value: 0

-

Since: 0.9.8.6

-
-
-
-

The “devices” property

-
  “devices”                  NMObjectArray *
-

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

-

Flags: Read

-

Since: 0.9.10

-
-
-
-

The “manager-running” property

-
  “manager-running”          gboolean
-

Whether the daemon is running.

-

Flags: Read

-

Default value: FALSE

-
-
-
-

The “networking-enabled” property

-
  “networking-enabled”       gboolean
-

Whether networking is enabled.

-

Flags: Read / Write

-

Default value: TRUE

-
-
-
-

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

-

Since: 0.9.8.6

-
-
-
-

The “startup” property

-
  “startup”                  gboolean
-

Whether the daemon is still starting up.

-

Flags: Read

-

Default value: FALSE

-

Since: 0.9.10

-
-
-
-

The “state” property

-
  “state”                    guint
-

The current daemon state.

-

Flags: Read

-

Allowed values: <= 70

-

Default value: 0

-
-
-
-

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