![]() |
![]() |
![]() |
libnm Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties | Signals |
#define NM_CLIENT_VERSION #define NM_CLIENT_STATE #define NM_CLIENT_STARTUP #define NM_CLIENT_NM_RUNNING #define NM_CLIENT_NETWORKING_ENABLED #define NM_CLIENT_WIRELESS_ENABLED #define NM_CLIENT_WIRELESS_HARDWARE_ENABLED #define NM_CLIENT_WWAN_ENABLED #define NM_CLIENT_WWAN_HARDWARE_ENABLED #define NM_CLIENT_WIMAX_ENABLED #define NM_CLIENT_WIMAX_HARDWARE_ENABLED #define NM_CLIENT_ACTIVE_CONNECTIONS #define NM_CLIENT_CONNECTIVITY #define NM_CLIENT_PRIMARY_CONNECTION #define NM_CLIENT_ACTIVATING_CONNECTION #define NM_CLIENT_DEVICES #define NM_CLIENT_ALL_DEVICES #define NM_CLIENT_CONNECTIONS #define NM_CLIENT_HOSTNAME #define NM_CLIENT_CAN_MODIFY #define NM_CLIENT_METERED #define NM_CLIENT_DEVICE_ADDED #define NM_CLIENT_DEVICE_REMOVED #define NM_CLIENT_ANY_DEVICE_ADDED #define NM_CLIENT_ANY_DEVICE_REMOVED #define NM_CLIENT_PERMISSION_CHANGED #define NM_CLIENT_CONNECTION_ADDED #define NM_CLIENT_CONNECTION_REMOVED #define NM_CLIENT_ACTIVE_CONNECTION_ADDED #define NM_CLIENT_ACTIVE_CONNECTION_REMOVED enum NMClientPermission; enum NMClientPermissionResult; enum NMClientError; #define NM_CLIENT_ERROR GQuark nm_client_error_quark (void
); NMClient; NMClientClass; NMClient * nm_client_new (GCancellable *cancellable
,GError **error
); void nm_client_new_async (GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); NMClient * nm_client_new_finish (GAsyncResult *result
,GError **error
); const char * nm_client_get_version (NMClient *client
); NMState nm_client_get_state (NMClient *client
); gboolean nm_client_get_startup (NMClient *client
); gboolean nm_client_get_nm_running (NMClient *client
); gboolean nm_client_networking_get_enabled (NMClient *client
); gboolean nm_client_networking_set_enabled (NMClient *client
,gboolean enabled
,GError **error
); gboolean nm_client_wireless_get_enabled (NMClient *client
); void nm_client_wireless_set_enabled (NMClient *client
,gboolean enabled
); gboolean nm_client_wireless_hardware_get_enabled (NMClient *client
); gboolean nm_client_wwan_get_enabled (NMClient *client
); void nm_client_wwan_set_enabled (NMClient *client
,gboolean enabled
); gboolean nm_client_wwan_hardware_get_enabled (NMClient *client
); gboolean nm_client_wimax_get_enabled (NMClient *client
); void nm_client_wimax_set_enabled (NMClient *client
,gboolean enabled
); gboolean nm_client_wimax_hardware_get_enabled (NMClient *client
); gboolean nm_client_get_logging (NMClient *client
,char **level
,char **domains
,GError **error
); gboolean nm_client_set_logging (NMClient *client
,const char *level
,const char *domains
,GError **error
); NMClientPermissionResult nm_client_get_permission_result (NMClient *client
,NMClientPermission permission
); NMConnectivityState nm_client_get_connectivity (NMClient *client
); NMConnectivityState nm_client_check_connectivity (NMClient *client
,GCancellable *cancellable
,GError **error
); void nm_client_check_connectivity_async (NMClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); NMConnectivityState nm_client_check_connectivity_finish (NMClient *client
,GAsyncResult *result
,GError **error
); gboolean nm_client_save_hostname (NMClient *client
,const char *hostname
,GCancellable *cancellable
,GError **error
); void nm_client_save_hostname_async (NMClient *client
,const char *hostname
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean nm_client_save_hostname_finish (NMClient *client
,GAsyncResult *result
,GError **error
); const GPtrArray * nm_client_get_devices (NMClient *client
); const GPtrArray * nm_client_get_all_devices (NMClient *client
); NMDevice * nm_client_get_device_by_path (NMClient *client
,const char *object_path
); NMDevice * nm_client_get_device_by_iface (NMClient *client
,const char *iface
); const GPtrArray * nm_client_get_active_connections (NMClient *client
); NMActiveConnection * nm_client_get_primary_connection (NMClient *client
); NMActiveConnection * nm_client_get_activating_connection (NMClient *client
); void nm_client_activate_connection_async (NMClient *client
,NMConnection *connection
,NMDevice *device
,const char *specific_object
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); NMActiveConnection * nm_client_activate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
); void nm_client_add_and_activate_connection_async (NMClient *client
,NMConnection *partial
,NMDevice *device
,const char *specific_object
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); NMActiveConnection * nm_client_add_and_activate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
); gboolean nm_client_deactivate_connection (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GError **error
); void nm_client_deactivate_connection_async (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean nm_client_deactivate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
); const GPtrArray * nm_client_get_connections (NMClient *client
); NMRemoteConnection * nm_client_get_connection_by_id (NMClient *client
,const char *id
); NMRemoteConnection * nm_client_get_connection_by_path (NMClient *client
,const char *path
); NMRemoteConnection * nm_client_get_connection_by_uuid (NMClient *client
,const char *uuid
); void nm_client_add_connection_async (NMClient *client
,NMConnection *connection
,gboolean save_to_disk
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); NMRemoteConnection * nm_client_add_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
); gboolean nm_client_load_connections (NMClient *client
,char **filenames
,char ***failures
,GCancellable *cancellable
,GError **error
); void nm_client_load_connections_async (NMClient *client
,char **filenames
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean nm_client_load_connections_finish (NMClient *client
,char ***failures
,GAsyncResult *result
,GError **error
); gboolean nm_client_reload_connections (NMClient *client
,GCancellable *cancellable
,GError **error
); void nm_client_reload_connections_async (NMClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
); gboolean nm_client_reload_connections_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
GEnum +----NMClientPermission
GEnum +----NMClientPermissionResult
GEnum +----NMClientError
GObject +----NMClient
"activating-connection" NMActiveConnection* : Read "active-connections" GPtrArray* : Read "all-devices" GPtrArray* : Read "can-modify" gboolean : Read "connections" GPtrArray* : Read "connectivity" NMConnectivityState : Read "devices" GPtrArray* : Read "hostname" gchar* : Read "metered" guint : Read "networking-enabled" gboolean : Read / Write "nm-running" gboolean : Read "primary-connection" NMActiveConnection* : Read "startup" gboolean : Read "state" NMState : Read "version" gchar* : Read "wimax-enabled" gboolean : Read / Write "wimax-hardware-enabled" gboolean : Read "wireless-enabled" gboolean : Read / Write "wireless-hardware-enabled" gboolean : Read "wwan-enabled" gboolean : Read / Write "wwan-hardware-enabled" gboolean : Read
"active-connection-added" :Run First
"active-connection-removed" :Run First
"any-device-added" :Run First
"any-device-removed" :Run First
"connection-added" :Run First
"connection-removed" :Run First
"device-added" :Run First
"device-removed" :Run First
"permission-changed" :Run First
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
#define NM_CLIENT_ACTIVE_CONNECTION_ADDED "active-connection-added"
#define NM_CLIENT_ACTIVE_CONNECTION_REMOVED "active-connection-removed"
typedef enum { NM_CLIENT_PERMISSION_NONE = 0, NM_CLIENT_PERMISSION_ENABLE_DISABLE_NETWORK = 1, NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIFI = 2, NM_CLIENT_PERMISSION_ENABLE_DISABLE_WWAN = 3, NM_CLIENT_PERMISSION_ENABLE_DISABLE_WIMAX = 4, NM_CLIENT_PERMISSION_SLEEP_WAKE = 5, NM_CLIENT_PERMISSION_NETWORK_CONTROL = 6, NM_CLIENT_PERMISSION_WIFI_SHARE_PROTECTED = 7, NM_CLIENT_PERMISSION_WIFI_SHARE_OPEN = 8, NM_CLIENT_PERMISSION_SETTINGS_MODIFY_SYSTEM = 9, NM_CLIENT_PERMISSION_SETTINGS_MODIFY_OWN = 10, NM_CLIENT_PERMISSION_SETTINGS_MODIFY_HOSTNAME = 11, NM_CLIENT_PERMISSION_SETTINGS_MODIFY_GLOBAL_DNS = 12, NM_CLIENT_PERMISSION_RELOAD = 13, NM_CLIENT_PERMISSION_CHECKPOINT_ROLLBACK = 14, NM_CLIENT_PERMISSION_ENABLE_DISABLE_STATISTICS = 15, NM_CLIENT_PERMISSION_LAST = 15, } NMClientPermission;
NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.
unknown or no permission | |
controls whether networking can be globally enabled or disabled | |
controls whether Wi-Fi can be globally enabled or disabled | |
controls whether WWAN (3G) can be globally enabled or disabled | |
controls whether WiMAX can be globally enabled or disabled | |
controls whether the client can ask NetworkManager to sleep and wake | |
controls whether networking connections can be started, stopped, and changed | |
controls whether a password protected Wi-Fi hotspot can be created | |
controls whether an open Wi-Fi hotspot can be created | |
controls whether connections that are available to all users can be modified | |
controls whether connections owned by the current user can be modified | |
controls whether the persistent hostname can be changed | |
modify persistent global DNS configuration | |
controls access to Reload. | |
permission to create checkpoints. | |
controls whether device statistics can be globally enabled or disabled | |
a reserved boundary value |
typedef enum { NM_CLIENT_PERMISSION_RESULT_UNKNOWN = 0, NM_CLIENT_PERMISSION_RESULT_YES, NM_CLIENT_PERMISSION_RESULT_AUTH, NM_CLIENT_PERMISSION_RESULT_NO } NMClientPermissionResult;
NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission
unknown or no authorization | |
the permission is available | |
authorization is necessary before the permission is available | |
permission to perform the operation is denied by system policy |
typedef enum { NM_CLIENT_ERROR_FAILED = 0, NM_CLIENT_ERROR_MANAGER_NOT_RUNNING, NM_CLIENT_ERROR_OBJECT_CREATION_FAILED, } NMClientError;
Describes errors that may result from operations involving a NMClient.
D-Bus operations may also return errors from other domains, including NMManagerError, NMSettingsError, NMAgentManagerError, and NMConnectionError.
unknown or unclassified error | |
an operation that requires NetworkManager failed because NetworkManager is not running | |
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. |
GQuark nm_client_error_quark (void
);
Registers an error quark for NMClient if necessary.
Returns : |
the error quark used for NMClient errors. |
typedef struct { GObjectClass parent; /* Signals */ void (*device_added) (NMClient *client, NMDevice *device); void (*device_removed) (NMClient *client, NMDevice *device); void (*any_device_added) (NMClient *client, NMDevice *device); void (*any_device_removed) (NMClient *client, NMDevice *device); void (*permission_changed) (NMClient *client, NMClientPermission permission, NMClientPermissionResult result); void (*connection_added) (NMClient *client, NMRemoteConnection *connection); void (*connection_removed) (NMClient *client, NMRemoteConnection *connection); } NMClientClass;
NMClient * nm_client_new (GCancellable *cancellable
,GError **error
);
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.
|
a GCancellable, or NULL
|
|
location for a GError, or NULL
|
Returns : |
a new NMClient or NULL on an error |
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.
|
a GCancellable, or NULL
|
|
callback to call when the client is created |
|
data for callback
|
NMClient * nm_client_new_finish (GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_new_async()
call.
|
a GAsyncResult |
|
location for a GError, or NULL
|
Returns : |
a new NMClient, or NULL on error |
const char * nm_client_get_version (NMClient *client
);
Gets NetworkManager version.
|
a NMClient |
Returns : |
string with the version (or NULL if NetworkManager is not running) |
NMState nm_client_get_state (NMClient *client
);
Gets the current daemon state.
gboolean nm_client_get_startup (NMClient *client
);
Tests whether the daemon is still in the process of activating connections at startup.
|
a NMClient |
Returns : |
whether the daemon is still starting up |
gboolean nm_client_get_nm_running (NMClient *client
);
Determines whether the daemon is running.
|
a NMClient |
Returns : |
TRUE if the daemon is running |
gboolean nm_client_networking_get_enabled (NMClient *client
);
Whether networking is enabled or disabled.
|
a NMClient |
Returns : |
TRUE if networking is enabled, FALSE if networking is disabled |
gboolean nm_client_networking_set_enabled (NMClient *client
,gboolean enabled
,GError **error
);
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.
|
a NMClient |
|
TRUE to set networking enabled, FALSE to set networking disabled |
|
return location for a GError, or NULL . [allow-none]
|
Returns : |
TRUE on success, FALSE otherwise |
gboolean nm_client_wireless_get_enabled (NMClient *client
);
Determines whether the wireless is enabled.
|
a NMClient |
Returns : |
TRUE if wireless is enabled |
void nm_client_wireless_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables wireless devices.
|
a NMClient |
|
TRUE to enable wireless |
gboolean nm_client_wireless_hardware_get_enabled
(NMClient *client
);
Determines whether the wireless hardware is enabled.
|
a NMClient |
Returns : |
TRUE if the wireless hardware is enabled |
gboolean nm_client_wwan_get_enabled (NMClient *client
);
Determines whether WWAN is enabled.
|
a NMClient |
Returns : |
TRUE if WWAN is enabled |
void nm_client_wwan_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables WWAN devices.
|
a NMClient |
|
TRUE to enable WWAN |
gboolean nm_client_wwan_hardware_get_enabled (NMClient *client
);
Determines whether the WWAN hardware is enabled.
|
a NMClient |
Returns : |
TRUE if the WWAN hardware is enabled |
gboolean nm_client_wimax_get_enabled (NMClient *client
);
Determines whether WiMAX is enabled.
|
a NMClient |
Returns : |
TRUE if WiMAX is enabled |
void nm_client_wimax_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables WiMAX devices.
|
a NMClient |
|
TRUE to enable WiMAX |
gboolean nm_client_wimax_hardware_get_enabled
(NMClient *client
);
Determines whether the WiMAX hardware is enabled.
|
a NMClient |
Returns : |
TRUE if the WiMAX hardware is enabled |
gboolean nm_client_get_logging (NMClient *client
,char **level
,char **domains
,GError **error
);
Gets NetworkManager current logging level and domains.
|
a NMClient |
|
return location for logging level string. [allow-none] |
|
return location for log domains string. The string is a list of domains separated by ",". [allow-none] |
|
return location for a GError, or NULL . [allow-none]
|
Returns : |
TRUE on success, FALSE otherwise |
gboolean nm_client_set_logging (NMClient *client
,const char *level
,const char *domains
,GError **error
);
Sets NetworkManager logging level and/or domains.
|
a NMClient |
|
logging level to set (NULL or an empty string for no change). [allow-none]
|
|
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]
|
|
return location for a GError, or NULL . [allow-none]
|
Returns : |
TRUE on success, FALSE otherwise |
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
|
a NMClient |
|
the permission for which to return the result, one of NMClientPermission |
Returns : |
the permission's result, one of NMClientPermissionResult |
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.
|
an NMClient |
Returns : |
the current connectivity state |
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.
|
an NMClient |
|
a GCancellable |
|
return location for a GError |
Returns : |
the (new) current connectivity state |
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.
|
an NMClient |
|
a GCancellable |
|
callback to call with the result |
|
data for callback . |
NMConnectivityState nm_client_check_connectivity_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Retrieves the result of an nm_client_check_connectivity_async()
call.
|
an NMClient |
|
the GAsyncResult |
|
return location for a GError |
Returns : |
the (new) current connectivity state |
gboolean nm_client_save_hostname (NMClient *client
,const char *hostname
,GCancellable *cancellable
,GError **error
);
Requests that the machine's persistent hostname be set to the specified value or cleared.
|
the NMClient
|
|
the new persistent hostname to set, or NULL to
clear any existing persistent hostname. [allow-none]
|
|
a GCancellable, or NULL
|
|
return location for GError |
Returns : |
TRUE if the request was successful, FALSE if it failed |
void nm_client_save_hostname_async (NMClient *client
,const char *hostname
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests that the machine's persistent hostname be set to the specified value or cleared.
|
the NMClient
|
|
the new persistent hostname to set, or NULL to
clear any existing persistent hostname. [allow-none]
|
|
a GCancellable, or NULL
|
|
callback to be called when the operation completes. [scope async] |
|
caller-specific data passed to callback . [closure]
|
gboolean nm_client_save_hostname_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_save_hostname_async()
call.
|
the NMClient
|
|
the result passed to the GAsyncReadyCallback |
|
return location for GError |
Returns : |
TRUE if the request was successful, FALSE if it failed |
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()
.
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()
.
|
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
NMDevice * nm_client_get_device_by_path (NMClient *client
,const char *object_path
);
NMDevice * nm_client_get_device_by_iface (NMClient *client
,const char *iface
);
const GPtrArray * nm_client_get_active_connections (NMClient *client
);
Gets the active connections.
|
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] |
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
.
|
an NMClient |
Returns : |
the appropriate NMActiveConnection, if any. [transfer none] |
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.
|
an NMClient |
Returns : |
the appropriate NMActiveConnection, if any. [transfer none] |
void nm_client_activate_connection_async (NMClient *client
,NMConnection *connection
,NMDevice *device
,const char *specific_object
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously 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.
|
a NMClient |
|
an NMConnection. [allow-none] |
|
the NMDevice. [allow-none] |
|
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]
|
|
a GCancellable, or NULL
|
|
callback to be called when the activation has started |
|
caller-specific data passed to callback
|
NMActiveConnection * nm_client_activate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_activate_connection_async()
.
|
an NMClient |
|
the result passed to the GAsyncReadyCallback |
|
location for a GError, or NULL
|
Returns : |
the new NMActiveConnection on success, NULL on
failure, in which case error will be set. [transfer full]
|
void nm_client_add_and_activate_connection_async (NMClient *client
,NMConnection *partial
,NMDevice *device
,const char *specific_object
,GCancellable *cancellable
,GAsyncReadyCallback 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 asynchronously
activated as with nm_client_activate_connection_async()
. 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.
|
a NMClient |
|
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]
|
|
the NMDevice |
|
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]
|
|
a GCancellable, or NULL
|
|
callback to be called when the activation has started |
|
caller-specific data passed to callback
|
NMActiveConnection * nm_client_add_and_activate_connection_finish (NMClient *client
,GAsyncResult *result
,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.
|
an NMClient |
|
the result passed to the GAsyncReadyCallback |
|
location for a GError, or NULL
|
Returns : |
the new NMActiveConnection on success, NULL on
failure, in which case error will be set. [transfer full]
|
gboolean nm_client_deactivate_connection (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GError **error
);
Deactivates an active NMActiveConnection.
|
a NMClient |
|
the NMActiveConnection to deactivate |
|
a GCancellable, or NULL
|
|
location for a GError, or NULL
|
Returns : |
success or failure |
void nm_client_deactivate_connection_async (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously deactivates an active NMActiveConnection.
|
a NMClient |
|
the NMActiveConnection to deactivate |
|
a GCancellable, or NULL
|
|
callback to be called when the deactivation has completed |
|
caller-specific data passed to callback
|
gboolean nm_client_deactivate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_deactivate_connection_async()
.
|
a NMClient |
|
the result passed to the GAsyncReadyCallback |
|
location for a GError, or NULL
|
Returns : |
success or failure |
const GPtrArray * nm_client_get_connections (NMClient *client
);
|
the NMClient
|
Returns : |
an array
containing all connections provided by the remote settings service. The
returned array is owned by the NMClient object and should not be modified.
The connections are as received from D-Bus and might not validate according
to nm_connection_verify() . [transfer none][element-type NMRemoteConnection]
|
NMRemoteConnection * nm_client_get_connection_by_id (NMClient *client
,const char *id
);
Returns the first matching NMRemoteConnection
matching a given id
.
|
the NMClient
|
|
the id of the remote connection |
Returns : |
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() . [transfer none]
|
NMRemoteConnection * nm_client_get_connection_by_path (NMClient *client
,const char *path
);
Returns the NMRemoteConnection
representing the connection at path
.
|
the NMClient
|
|
the D-Bus object path of the remote connection |
Returns : |
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() . [transfer none]
|
NMRemoteConnection * nm_client_get_connection_by_uuid (NMClient *client
,const char *uuid
);
Returns the NMRemoteConnection
identified by uuid
.
|
the NMClient
|
|
the UUID of the remote connection |
Returns : |
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() . [transfer none]
|
void nm_client_add_connection_async (NMClient *client
,NMConnection *connection
,gboolean save_to_disk
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests that the remote settings service add the given settings to a new
connection. If save_to_disk
is TRUE
, the connection is immediately written
to disk; otherwise it is initially only stored in memory, but may be saved
later by calling the connection's nm_remote_connection_commit_changes()
method.
connection
is untouched by this function and only serves as a template of
the settings to add. The NMRemoteConnection object that represents what
NetworkManager actually added is returned to callback
when the addition
operation is complete.
Note that the NMRemoteConnection returned in callback
may not contain
identical settings to connection
as NetworkManager may perform automatic
completion and/or normalization of connection properties.
|
the NMClient
|
|
the connection to add. Note that this object's settings will be added, not the object itself |
|
whether to immediately save the connection to disk |
|
a GCancellable, or NULL
|
|
callback to be called when the add operation completes. [scope async] |
|
caller-specific data passed to callback . [closure]
|
NMRemoteConnection * nm_client_add_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_add_connection_async()
.
|
an NMClient |
|
the result passed to the GAsyncReadyCallback |
|
location for a GError, or NULL
|
Returns : |
the new NMRemoteConnection on success, NULL on
failure, in which case error will be set. [transfer full]
|
gboolean nm_client_load_connections (NMClient *client
,char **filenames
,char ***failures
,GCancellable *cancellable
,GError **error
);
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
client
's connections array when the function returns.
If all of the indicated files were successfully loaded, the
function will return TRUE
, and failures
will be set to NULL
. If
NetworkManager tried to load the files, but some (or all) failed,
then failures
will be set to a NULL
-terminated array of the
filenames that failed to load.
|
the NMClient
|
|
NULL -terminated array of filenames to load. [array zero-terminated=1]
|
|
on return, a NULL -terminated array of
filenames that failed to load. [out][transfer full]
|
|
a GCancellable, or NULL
|
|
return location for GError |
Returns : |
TRUE if NetworkManager at least tried to load filenames ,
FALSE if an error occurred (eg, permission denied). |
void nm_client_load_connections_async (NMClient *client
,char **filenames
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests that the remote settings service asynchronously load or reload the given files, adding or updating the connections described within.
See nm_client_load_connections()
for more details.
|
the NMClient
|
|
NULL -terminated array of filenames to load. [array zero-terminated=1]
|
|
a GCancellable, or NULL
|
|
callback to be called when the operation completes. [scope async] |
|
caller-specific data passed to callback . [closure]
|
gboolean nm_client_load_connections_finish (NMClient *client
,char ***failures
,GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_load_connections_async()
call.
See nm_client_load_connections()
for more details.
|
the NMClient
|
|
on return, a
NULL -terminated array of filenames that failed to load. [out][transfer full][array zero-terminated=1]
|
|
the result passed to the GAsyncReadyCallback |
|
location for a GError, or NULL
|
Returns : |
TRUE if NetworkManager at least tried to load filenames ,
FALSE if an error occurred (eg, permission denied). |
gboolean nm_client_reload_connections (NMClient *client
,GCancellable *cancellable
,GError **error
);
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.
|
the NMClient |
|
a GCancellable, or NULL
|
|
return location for GError |
Returns : |
TRUE on success, FALSE on failure |
void nm_client_reload_connections_async (NMClient *client
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Requests that the remote settings service begin reloading all connection files from disk, adding, updating, and removing connections until the in-memory state matches the on-disk state.
|
the NMClient |
|
a GCancellable, or NULL
|
|
callback to be called when the reload operation completes. [scope async] |
|
caller-specific data passed to callback . [closure]
|
gboolean nm_client_reload_connections_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_reload_connections_async()
call.
|
the NMClient |
|
the result passed to the GAsyncReadyCallback |
|
return location for GError |
Returns : |
TRUE on success, FALSE on failure |
"activating-connection"
property"activating-connection" NMActiveConnection* : Read
The NMActiveConnection of the activating connection that is likely to become the new "primary-connection".
"active-connections"
property "active-connections" GPtrArray* : Read
The active connections.
Element-type: NMActiveConnection
"all-devices"
property "all-devices" GPtrArray* : Read
List of both real devices and device placeholders.
Element-type: NMDevice
Since 1.2
"can-modify"
property "can-modify" gboolean : Read
If TRUE
, adding and modifying connections is supported.
Default value: FALSE
"connections"
property "connections" GPtrArray* : Read
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.)
Element-type: NMRemoteConnection
"connectivity"
property"connectivity" NMConnectivityState : Read
The network connectivity state.
Default value: NM_CONNECTIVITY_UNKNOWN
"devices"
property "devices" GPtrArray* : Read
List of real network devices. Does not include placeholder devices.
Element-type: NMDevice
"hostname"
property "hostname" gchar* : Read
The machine hostname stored in persistent configuration. This can be
modified by calling nm_client_save_hostname()
.
Default value: NULL
"metered"
property "metered" guint : Read
Whether the connectivity is metered.
Default value: 0
Since 1.2
"networking-enabled"
property "networking-enabled" gboolean : Read / Write
Whether networking is enabled.
Default value: TRUE
"nm-running"
property "nm-running" gboolean : Read
Whether the daemon is running.
Default value: FALSE
"primary-connection"
property"primary-connection" NMActiveConnection* : Read
The NMActiveConnection of the device with the default route;
see nm_client_get_primary_connection()
for more details.
"startup"
property "startup" gboolean : Read
Whether the daemon is still starting up.
Default value: FALSE
"state"
property"state" NMState : Read
The current daemon state.
Default value: NM_STATE_UNKNOWN
"wimax-enabled"
property "wimax-enabled" gboolean : Read / Write
Whether WiMAX functionality is enabled.
Default value: FALSE
"wimax-hardware-enabled"
property "wimax-hardware-enabled" gboolean : Read
Whether the WiMAX hardware is enabled.
Default value: FALSE
"wireless-enabled"
property "wireless-enabled" gboolean : Read / Write
Whether wireless is enabled.
Default value: FALSE
"wireless-hardware-enabled"
property "wireless-hardware-enabled" gboolean : Read
Whether the wireless hardware is enabled.
Default value: TRUE
"wwan-enabled"
property "wwan-enabled" gboolean : Read / Write
Whether WWAN functionality is enabled.
Default value: FALSE
"active-connection-added"
signalvoid user_function (NMClient *client,
NMActiveConnection *active_connection,
gpointer user_data) : Run First
Notifies that a NMActiveConnection has been added.
|
the settings object that received the signal |
|
the new active connection |
|
user data set when the signal handler was connected. |
"active-connection-removed"
signalvoid user_function (NMClient *client,
NMActiveConnection *active_connection,
gpointer user_data) : Run First
Notifies that a NMActiveConnection has been removed.
|
the settings object that received the signal |
|
the removed active connection |
|
user data set when the signal handler was connected. |
"any-device-added"
signalvoid user_function (NMClient *client,
GObject *device,
gpointer user_data) : Run First
Notifies that a NMDevice is added. This signal is emitted for both regular devices and placeholder devices.
|
the client that received the signal |
|
the new device. [type NMDevice] |
|
user data set when the signal handler was connected. |
"any-device-removed"
signalvoid user_function (NMClient *client,
GObject *device,
gpointer user_data) : Run First
Notifies that a NMDevice is removed. This signal is emitted for both regular devices and placeholder devices.
|
the client that received the signal |
|
the removed device. [type NMDevice] |
|
user data set when the signal handler was connected. |
"connection-added"
signalvoid user_function (NMClient *client,
NMRemoteConnection *connection,
gpointer user_data) : Run First
Notifies that a NMConnection has been added.
|
the settings object that received the signal |
|
the new connection |
|
user data set when the signal handler was connected. |
"connection-removed"
signalvoid user_function (NMClient *client,
NMRemoteConnection *connection,
gpointer user_data) : Run First
Notifies that a NMConnection has been removed.
|
the settings object that received the signal |
|
the removed connection |
|
user data set when the signal handler was connected. |
"device-added"
signalvoid user_function (NMClient *client,
GObject *device,
gpointer user_data) : Run First
Notifies that a NMDevice is added. This signal is not emitted for placeholder devices.
|
the client that received the signal |
|
the new device. [type NMDevice] |
|
user data set when the signal handler was connected. |
"device-removed"
signalvoid user_function (NMClient *client,
GObject *device,
gpointer user_data) : Run First
Notifies that a NMDevice is removed. This signal is not emitted for placeholder devices.
|
the client that received the signal |
|
the removed device. [type NMDevice] |
|
user data set when the signal handler was connected. |
"permission-changed"
signalvoid user_function (NMClient *client,
guint permission,
guint result,
gpointer user_data) : Run First
Notifies that a permission has changed
|
the client that received the signal |
|
a permission from NMClientPermission |
|
the permission's result, one of NMClientPermissionResult |
|
user data set when the signal handler was connected. |