Top |
Functions
Properties
NMActiveConnection * | activating-connection | Read |
GPtrArray * | active-connections | Read |
gboolean | can-modify | Read |
GPtrArray * | connections | Read |
NMConnectivityState | connectivity | Read |
GPtrArray * | devices | Read |
gchar * | hostname | Read |
gboolean | networking-enabled | Read / Write |
gboolean | nm-running | Read |
NMActiveConnection * | primary-connection | Read |
gboolean | startup | Read |
NMState | state | Read |
gchar * | version | Read |
gboolean | wimax-enabled | Read / Write |
gboolean | wimax-hardware-enabled | Read |
gboolean | wireless-enabled | Read / Write |
gboolean | wireless-hardware-enabled | Read |
gboolean | wwan-enabled | Read / Write |
gboolean | wwan-hardware-enabled | Read |
Signals
void | connection-added | Run First |
void | connection-removed | Run First |
void | device-added | Run First |
void | device-removed | Run First |
void | permission-changed | Run First |
Types and Values
#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_CONNECTIONS |
#define | NM_CLIENT_HOSTNAME |
#define | NM_CLIENT_CAN_MODIFY |
#define | NM_CLIENT_DEVICE_ADDED |
#define | NM_CLIENT_DEVICE_REMOVED |
#define | NM_CLIENT_PERMISSION_CHANGED |
#define | NM_CLIENT_CONNECTION_ADDED |
#define | NM_CLIENT_CONNECTION_REMOVED |
enum | NMClientPermission |
enum | NMClientPermissionResult |
enum | NMClientError |
#define | NM_CLIENT_ERROR |
Object Hierarchy
GEnum ├── NMClientError ├── NMClientPermission ╰── NMClientPermissionResult GObject ╰── NMClient
Functions
nm_client_error_quark ()
GQuark
nm_client_error_quark (void
);
Registers an error quark for NMClient if necessary.
nm_client_new ()
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.
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.
nm_client_new_finish ()
NMClient * nm_client_new_finish (GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_new_async()
call.
nm_client_get_version ()
const char *
nm_client_get_version (NMClient *client
);
Gets NetworkManager version.
nm_client_get_state ()
NMState
nm_client_get_state (NMClient *client
);
Gets the current daemon state.
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.
nm_client_get_nm_running ()
gboolean
nm_client_get_nm_running (NMClient *client
);
Determines whether the daemon is running.
nm_client_networking_get_enabled ()
gboolean
nm_client_networking_get_enabled (NMClient *client
);
Whether networking is enabled or disabled.
nm_client_networking_set_enabled ()
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.
Parameters
client |
a NMClient |
|
enabled |
|
|
error |
return location for a GError, or |
[allow-none] |
nm_client_wireless_get_enabled ()
gboolean
nm_client_wireless_get_enabled (NMClient *client
);
Determines whether the wireless is enabled.
nm_client_wireless_set_enabled ()
void nm_client_wireless_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables wireless devices.
nm_client_wireless_hardware_get_enabled ()
gboolean
nm_client_wireless_hardware_get_enabled
(NMClient *client
);
Determines whether the wireless hardware is enabled.
nm_client_wwan_get_enabled ()
gboolean
nm_client_wwan_get_enabled (NMClient *client
);
Determines whether WWAN is enabled.
nm_client_wwan_set_enabled ()
void nm_client_wwan_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables WWAN devices.
nm_client_wwan_hardware_get_enabled ()
gboolean
nm_client_wwan_hardware_get_enabled (NMClient *client
);
Determines whether the WWAN hardware is enabled.
nm_client_wimax_get_enabled ()
gboolean
nm_client_wimax_get_enabled (NMClient *client
);
Determines whether WiMAX is enabled.
nm_client_wimax_set_enabled ()
void nm_client_wimax_set_enabled (NMClient *client
,gboolean enabled
);
Enables or disables WiMAX devices.
nm_client_wimax_hardware_get_enabled ()
gboolean
nm_client_wimax_hardware_get_enabled (NMClient *client
);
Determines whether the WiMAX hardware is enabled.
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 |
[allow-none] |
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 ( |
[allow-none] |
domains |
logging domains to set. The string should be a list of log
domains separated by ",". ( |
[allow-none] |
error |
return location for a GError, or |
[allow-none] |
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 |
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.
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.
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 |
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.
nm_client_save_hostname ()
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.
Parameters
client |
the |
|
hostname |
the new persistent hostname to set, or |
[allow-none] |
cancellable |
a GCancellable, or |
|
error |
return location for GError |
nm_client_save_hostname_async ()
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.
Parameters
client |
the |
|
hostname |
the new persistent hostname to set, or |
[allow-none] |
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the operation completes. |
[scope async] |
user_data |
caller-specific data passed to |
[closure] |
nm_client_save_hostname_finish ()
gboolean nm_client_save_hostname_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_save_hostname_async()
call.
Parameters
client |
the |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
return location for GError |
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()
.
nm_client_get_device_by_path ()
NMDevice * nm_client_get_device_by_path (NMClient *client
,const char *object_path
);
nm_client_get_device_by_iface ()
NMDevice * nm_client_get_device_by_iface (NMClient *client
,const char *iface
);
nm_client_get_active_connections ()
const GPtrArray *
nm_client_get_active_connections (NMClient *client
);
Gets the active connections.
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_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
.
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.
nm_client_activate_connection_async ()
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.
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 |
[allow-none] |
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the activation has started |
|
user_data |
caller-specific data passed to |
nm_client_activate_connection_finish ()
NMActiveConnection * nm_client_activate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_activate_connection_async()
.
Parameters
client |
an NMClient |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
location for a GError, or |
Returns
the new NMActiveConnection on success, NULL
on
failure, in which case error
will be set.
[transfer full]
nm_client_add_and_activate_connection_async ()
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.
Parameters
client |
a NMClient |
|
partial |
an NMConnection to add; the connection may be
partially filled (or even |
[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 |
[allow-none] |
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the activation has started |
|
user_data |
caller-specific data passed to |
nm_client_add_and_activate_connection_finish ()
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.
Parameters
client |
an NMClient |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
location for a GError, or |
Returns
the new NMActiveConnection on success, NULL
on
failure, in which case error
will be set.
[transfer full]
nm_client_deactivate_connection ()
gboolean nm_client_deactivate_connection (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GError **error
);
Deactivates an active NMActiveConnection.
Parameters
client |
a NMClient |
|
active |
the NMActiveConnection to deactivate |
|
cancellable |
a GCancellable, or |
|
error |
location for a GError, or |
nm_client_deactivate_connection_async ()
void nm_client_deactivate_connection_async (NMClient *client
,NMActiveConnection *active
,GCancellable *cancellable
,GAsyncReadyCallback callback
,gpointer user_data
);
Asynchronously deactivates an active NMActiveConnection.
Parameters
client |
a NMClient |
|
active |
the NMActiveConnection to deactivate |
|
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the deactivation has completed |
|
user_data |
caller-specific data passed to |
nm_client_deactivate_connection_finish ()
gboolean nm_client_deactivate_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_deactivate_connection_async()
.
Parameters
client |
a NMClient |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
location for a GError, or |
nm_client_get_connections ()
const GPtrArray *
nm_client_get_connections (NMClient *client
);
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.
[transfer none][element-type NMRemoteConnection]
nm_client_get_connection_by_id ()
NMRemoteConnection * nm_client_get_connection_by_id (NMClient *client
,const char *id
);
Returns the first matching NMRemoteConnection
matching a given id
.
nm_client_get_connection_by_path ()
NMRemoteConnection * nm_client_get_connection_by_path (NMClient *client
,const char *path
);
Returns the NMRemoteConnection
representing the connection at path
.
nm_client_get_connection_by_uuid ()
NMRemoteConnection * nm_client_get_connection_by_uuid (NMClient *client
,const char *uuid
);
Returns the NMRemoteConnection
identified by uuid
.
nm_client_add_connection_async ()
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.
Parameters
client |
the |
|
connection |
the connection to add. Note that this object's settings will be added, not the object itself |
|
save_to_disk |
whether to immediately save the connection to disk |
|
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the add operation completes. |
[scope async] |
user_data |
caller-specific data passed to |
[closure] |
nm_client_add_connection_finish ()
NMRemoteConnection * nm_client_add_connection_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of a call to nm_client_add_connection_async()
.
Parameters
client |
an NMClient |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
location for a GError, or |
Returns
the new NMRemoteConnection on success, NULL
on
failure, in which case error
will be set.
[transfer full]
nm_client_load_connections ()
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.
Parameters
client |
the |
|
filenames |
|
|
failures |
on return, a |
[out][transfer full] |
cancellable |
a GCancellable, or |
|
error |
return location for GError |
nm_client_load_connections_async ()
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.
Parameters
client |
the |
|
filenames |
|
|
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the operation completes. |
[scope async] |
user_data |
caller-specific data passed to |
[closure] |
nm_client_load_connections_finish ()
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.
Parameters
client |
the |
|
failures |
on return, a |
[out][transfer full] |
result |
the result passed to the GAsyncReadyCallback |
|
error |
location for a GError, or |
nm_client_reload_connections ()
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.
nm_client_reload_connections_async ()
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.
Parameters
client |
the NMClient |
|
cancellable |
a GCancellable, or |
|
callback |
callback to be called when the reload operation completes. |
[scope async] |
user_data |
caller-specific data passed to |
[closure] |
nm_client_reload_connections_finish ()
gboolean nm_client_reload_connections_finish (NMClient *client
,GAsyncResult *result
,GError **error
);
Gets the result of an nm_client_reload_connections_async()
call.
Parameters
client |
the NMClient |
|
result |
the result passed to the GAsyncReadyCallback |
|
error |
return location for GError |
Types and Values
NM_CLIENT_WIRELESS_HARDWARE_ENABLED
#define NM_CLIENT_WIRELESS_HARDWARE_ENABLED "wireless-hardware-enabled"
enum NMClientPermission
NMClientPermission values indicate various permissions that NetworkManager clients can obtain to perform certain tasks on behalf of the current user.
Members
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 |
||
a reserved boundary value |
enum NMClientPermissionResult
NMClientPermissionResult values indicate what authorizations and permissions the user requires to obtain a given NMClientPermission
enum 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.
Members
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. |
Property Details
The “connectivity”
property
“connectivity” NMConnectivityState
Flags: Read
Default value: NM_CONNECTIVITY_UNKNOWN
The “networking-enabled”
property
“networking-enabled” gboolean
Flags: Read / Write
Default value: TRUE
The “wimax-hardware-enabled”
property
“wimax-hardware-enabled” gboolean
Flags: Read
Default value: FALSE
The “wireless-enabled”
property
“wireless-enabled” gboolean
Flags: Read / Write
Default value: FALSE
The “wireless-hardware-enabled”
property
“wireless-hardware-enabled” gboolean
Flags: Read
Default value: TRUE
Signal Details
The “connection-added”
signal
void user_function (NMClient *client, NMRemoteConnection *connection, gpointer user_data)
Flags: Run First
The “connection-removed”
signal
void user_function (NMClient *client, NMRemoteConnection *connection, gpointer user_data)
Flags: Run First
The “device-added”
signal
void user_function (NMClient *client, GObject *device, gpointer user_data)
Flags: Run First
The “device-removed”
signal
void user_function (NMClient *client, GObject *device, gpointer user_data)
Flags: Run First
The “permission-changed”
signal
void user_function (NMClient *client, guint permission, guint result, gpointer user_data)
Flags: Run First