a valid and connected D-Bus connection
the D-Bus path of the connection as exported by the settings service
The connection's D-Bus path, used only by the calling process as a record of the D-Bus path of the connection as provided by a settings service.
%TRUE if the remote connection contains changes that have not been saved to disk, %FALSE if the connection is the same as its on-disk representation.
Adds a #NMSetting to the connection, replacing any previous #NMSetting of the same name which has previously been added to the #NMConnection. The connection takes ownership of the #NMSetting object and does not increase the setting object's reference count.
the #NMSetting to add to the connection object
Creates a binding between source_property on source and target_property
on target.
Whenever the source_property is changed the target_property is
updated using the same value. For instance:
g_object_bind_property (action, "active", widget, "sensitive", 0);
Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.
If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
if target_property on target changes then the source_property on source
will be updated as well.
The binding will automatically be removed when either the source or the
target instances are finalized. To remove the binding without affecting the
source and the target you can just call g_object_unref() on the returned
#GBinding instance.
Removing the binding by calling g_object_unref() on it must only be done if
the binding, source and target are only used from a single thread and it
is clear that both source and target outlive the binding. Especially it
is not safe to rely on this if the binding, source or target can be
finalized from different threads. Keep another reference to the binding and
use g_binding_unbind() instead to be on the safe side.
A #GObject can have multiple bindings.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
Creates a binding between source_property on source and target_property
on target, allowing you to set the transformation functions to be used by
the binding.
This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.
the property on source to bind
the target #GObject
the property on target to bind
flags to pass to #GBinding
a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default
a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default
Clears and frees any secrets that may be stored in the connection, to avoid keeping secret data in memory when not needed.
Clears and frees secrets determined by func.
function to be called to determine whether a specific secret should be cleared or not
Send any local changes to the settings and properties of this connection to NetworkManager, which will immediately save them to disk.
a function to be called when the commit completes
Send any local changes to the settings and properties of this connection to NetworkManager. The changes are not saved to disk until either nm_remote_connection_save() or nm_remote_connection_commit_changes() is called.
a function to be called when the commit completes
Compares two #NMConnection objects for similarity, with comparison behavior modified by a set of flags. See nm_setting_compare() for a description of each flag's behavior.
a second #NMConnection to compare with the first
compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
Delete the connection.
a function to be called when the delete completes
Compares two #NMConnection objects for similarity, with comparison behavior
modified by a set of flags. See nm_setting_compare() for a description of
each flag's behavior. If the connections differ, settings and keys within
each setting that differ are added to the returned out_settings hash table.
No values are returned, only key names.
a second #NMConnection to compare with the first
compare flags, e.g. %NM_SETTING_COMPARE_FLAG_EXACT
if the connections differ, on return a hash table mapping setting names to second-level GHashTable (utf8 to guint32), which contains the key names that differ mapped to one or more of %NMSettingDiffResult as a bitfield
Print the connection to stdout. For debugging purposes ONLY, should NOT be used for serialization of the connection or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.
Duplicates a #NMConnection.
Iterates over the properties of each #NMSetting object in the #NMConnection, calling the supplied user function for each property.
user-supplied function called for each setting's property
This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().
Increases the freeze count on object. If the freeze count is
non-zero, the emission of "notify" signals on object is
stopped. The signals are queued until the freeze count is decreased
to zero. Duplicate notifications are squashed so that at most one
#GObject::notify signal is emitted for each property modified while the
object is frozen.
This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.
A shortcut to return the type from the connection's #NMSettingConnection.
Gets a named field from the objects table of associations (see g_object_set_data()).
name of the key for that association
A shortcut to return the ID from the connection's #NMSettingConnection.
Returns the interface name as stored in NMSettingConnection:interface_name. If the connection contains no NMSettingConnection, it will return %NULL.
For hardware devices and software devices created outside of NetworkManager, this name is used to match the device. for software devices created by NetworkManager, this is the name of the created interface.
Returns the connection's D-Bus path.
Gets a property of an object.
The value can be:
In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().
Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.
the name of the property to get
return location for the property value
This function gets back user data pointers stored via g_object_set_qdata().
A #GQuark, naming the user data pointer
Request the connection's secrets.
the #NMSetting object name to get secrets for
a function to be called when the update completes; must not be %NULL
Gets the #NMSetting with the given #GType, if one has been previously added to the #NMConnection.
the #GType of the setting object to return
A shortcut to return any #NMSetting8021x the connection might contain.
A shortcut to return any #NMSettingAdsl the connection might contain.
A shortcut to return any #NMSettingBluetooth the connection might contain.
A shortcut to return any #NMSettingBond the connection might contain.
A shortcut to return any #NMSettingBridge the connection might contain.
A shortcut to return any #NMSettingBridgePort the connection might contain.
Gets the #NMSetting with the given name, if one has been previously added the #NMConnection.
a setting name
A shortcut to return any #NMSettingCdma the connection might contain.
A shortcut to return any #NMSettingConnection the connection might contain.
A shortcut to return any #NMSettingDcb the connection might contain.
A shortcut to return any #NMSettingGeneric the connection might contain.
A shortcut to return any #NMSettingGsm the connection might contain.
A shortcut to return any #NMSettingInfiniband the connection might contain.
A shortcut to return any #NMSettingIP4Config the connection might contain.
A shortcut to return any #NMSettingIP6Config the connection might contain.
A shortcut to return any #NMSettingOlpcMesh the connection might contain.
A shortcut to return any #NMSettingPPP the connection might contain.
A shortcut to return any #NMSettingPPPOE the connection might contain.
A shortcut to return any #NMSettingSerial the connection might contain.
A shortcut to return any #NMSettingTeam the connection might contain.
A shortcut to return any #NMSettingTeamPort the connection might contain.
A shortcut to return any #NMSettingVlan the connection might contain.
A shortcut to return any #NMSettingVPN the connection might contain.
A shortcut to return any #NMSettingWimax the connection might contain.
A shortcut to return any #NMSettingWired the connection might contain.
A shortcut to return any #NMSettingWireless the connection might contain.
A shortcut to return any #NMSettingWirelessSecurity the connection might contain.
A shortcut to return the UUID from the connection's #NMSettingConnection.
Returns the name that nm_device_disambiguate_names() would
return for the virtual device that would be created for connection.
Eg, "VLAN (eth1.1)".
Returns the name of the virtual kernel interface which the connection needs to use if specified in the settings. This function abstracts all connection types which require this functionality. For all other connection types, this function will return %NULL.
Gets n_properties properties for an object.
Obtained properties will be set to values. All properties must be valid.
Warnings will be emitted and undefined behaviour may result if invalid
properties are passed in.
the names of each property to get
the values of each property to get
Initializes the object implementing the interface.
This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.
The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().
Implementations may also support cancellation. If cancellable is not %NULL,
then initialization can be cancelled by triggering the cancellable object
from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and
the object doesn't support cancellable initialization the error
%G_IO_ERROR_NOT_SUPPORTED will be returned.
If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.
Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.
If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.
One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.
optional #GCancellable object, %NULL to ignore.
Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.
This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.
When the initialization is finished, callback will be called. You can
then call g_async_initable_init_finish() to get the result of the
initialization.
Implementations may also support cancellation. If cancellable is not
%NULL, then initialization can be cancelled by triggering the cancellable
object from another thread. If the operation was cancelled, the error
%G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and
the object doesn't support cancellable initialization, the error
%G_IO_ERROR_NOT_SUPPORTED will be returned.
As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.
Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.
For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.
the [I/O priority][io-priority] of the operation
optional #GCancellable object, %NULL to ignore.
a #GAsyncReadyCallback to call when the request is satisfied
Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().
a #GAsyncResult.
Checks whether object has a [floating][floating-ref] reference.
A convenience function to check if the given connection is a particular
type (ie wired, Wi-Fi, ppp, etc). Checks the #NMSettingConnection:type
property of the connection and matches that against type.
a setting name to check the connection's type against (like %NM_SETTING_WIRELESS_SETTING_NAME or %NM_SETTING_WIRED_SETTING_NAME)
Returns the name of the first setting object in the connection which would need secrets to make a successful connection. The returned hints are only intended as a guide to what secrets may be required, because in some circumstances, there is no way to conclusively determine exactly which secrets are needed.
Finishes the async construction for the various g_async_initable_new calls, returning the created object or %NULL on error.
the #GAsyncResult from the callback
Does some basic normalization and fixup of well known inconsistencies
and deprecated fields. If the connection was modified in any way,
the output parameter modified is set %TRUE.
Finally the connection will be verified and %TRUE returns if the connection is valid. As this function only performs some specific normalization steps it cannot repair all connections. If the connection has errors that cannot be normalized, the connection will not be modified.
a #GHashTable with normalization parameters to allow customization of the normalization by providing specific arguments. Unknown arguments will be ignored and the default will be used. The keys must be strings, hashed by g_str_hash() and g_str_equal() functions. The values are opaque and depend on the parameter name.
Emits a "notify" signal for the property property_name on object.
When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.
Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.
the name of a property installed on the class of object.
Emits a "notify" signal for the property specified by pspec on object.
This function omits the property name lookup, hence it is faster than g_object_notify().
One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:
enum
{
PROP_0,
PROP_FOO,
PROP_LAST
};
static GParamSpec *properties[PROP_LAST];
static void
my_object_class_init (MyObjectClass *klass)
{
properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
0, 100,
50,
G_PARAM_READWRITE);
g_object_class_install_property (gobject_class,
PROP_FOO,
properties[PROP_FOO]);
}
and then notify a change on the "foo" property with:
g_object_notify_by_pspec (self, properties[PROP_FOO]);
the #GParamSpec of a property installed on the class of object.
Increase the reference count of object, and possibly remove the
[floating][floating-ref] reference, if object has a floating reference.
In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.
Since GLib 2.56, the type of object will be propagated to the return type
under the same conditions as for g_object_ref().
Removes the #NMSetting with the given #GType from the #NMConnection. This operation dereferences the #NMSetting object.
the #GType of the setting object to remove
Deep-copies the settings of new_conenction and replaces the settings of connection
with the copied settings.
a #NMConnection to replace the settings of connection with
Releases all references to other objects. This can be used to break reference cycles.
This function should only be called from object system implementations.
Saves the connection to disk if the connection has changes that have not yet been written to disk, or if the connection has never been saved.
a function to be called when the save completes
Each object carries around a table of associations from strings to pointers. This function lets you set an association.
If the object already had an association with that name, the old association will be destroyed.
Internally, the key is converted to a #GQuark using g_quark_from_string().
This means a copy of key is kept permanently (even after object has been
finalized) — so it is recommended to only use a small, bounded set of values
for key in your program, to avoid the #GQuark storage growing unbounded.
name of the key
data to associate with that key
Sets the D-Bus path of the connection. This property is not serialized, and is only for the reference of the caller. Sets the #NMConnection:path property.
the D-Bus path of the connection as given by the settings service which provides the connection
Sets a property on an object.
the name of the property to set
the value
Remove a specified datum from the object's data associations, without invoking the association's destroy handler.
name of the key
This function gets back user data pointers stored via
g_object_set_qdata() and removes the data from object
without invoking its destroy() function (if any was
set).
Usually, calling this function is only required to update
user data pointers with a destroy notifier, for example:
void
object_add_to_user_list (GObject *object,
const gchar *new_string)
{
// the quark, naming the object data
GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
// retrieve the old string list
GList *list = g_object_steal_qdata (object, quark_string_list);
// prepend new string
list = g_list_prepend (list, g_strdup (new_string));
// this changed 'list', so we need to set it again
g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
}
static void
free_string_list (gpointer data)
{
GList *node, *list = data;
for (node = list; node; node = node->next)
g_free (node->data);
g_list_free (list);
}
Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().
A #GQuark, naming the user data pointer
Reverts the effect of a previous call to
g_object_freeze_notify(). The freeze count is decreased on object
and when it reaches zero, queued "notify" signals are emitted.
Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.
It is an error to call this function when the freeze count is zero.
Converts the #NMConnection into a #GHashTable describing the connection, suitable for marshalling over D-Bus or serializing. The hash table mapping is string:#GHashTable with each element in the returned hash representing a #NMSetting object. The keys are setting object names, and the values are #GHashTables mapping string:GValue, each of which represents the properties of the #NMSetting object.
hash flags, e.g. %NM_SETTING_HASH_FLAG_ALL
Decreases the reference count of object. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).
If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.
Update the specified setting's secrets, given a hash table of secrets
intended for that setting (deserialized from D-Bus for example). Will also
extract the given setting's secrets hash if given a hash of hashes, as would
be returned from nm_connection_to_hash(). If setting_name is %NULL, expects
a fully serialized #NMConnection as returned by nm_connection_to_hash() and
will update all secrets from all settings contained in secrets.
the setting object name to which the secrets apply
a #GHashTable mapping string:#GValue of setting property names and secrets of the given setting_name
Validates the connection and all its settings. Each setting's properties have allowed values, and some values are dependent on other values. For example, if a Wi-Fi connection is security enabled, the #NMSettingWireless setting object's 'security' property must contain the setting name of the #NMSettingWirelessSecurity object, which must also be present in the connection for the connection to be valid. As another example, the #NMSettingWired object's 'mac-address' property must be a validly formatted MAC address. The returned #GError contains information about which setting and which property failed validation, and how it failed validation.
This function essentially limits the life time of the closure to
the life time of the object. That is, when the object is finalized,
the closure is invalidated by calling g_closure_invalidate() on
it, in order to prevent invocations of the closure with a finalized
(nonexisting) object. Also, g_object_ref() and g_object_unref() are
added as marshal guards to the closure, to ensure that an extra
reference count is held on object during invocation of the
closure. Usually, this function will be called on closures that
use this object as closure data.
#GClosure to watch
Create a new #NMSetting object of the desired type, given a setting name.
a setting name
Find the #GParamSpec with the given name for an
interface. Generally, the interface vtable passed in as g_iface
will be the default vtable from g_type_default_interface_ref(), or,
if you know the interface has already been loaded,
g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
name of a property to look up.
Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.
This function is meant to be called from the interface's default
vtable initialization function (the class_init member of
#GTypeInfo.) It must not be called after after class_init has
been called for any object types implementing this interface.
If pspec is a floating reference, it will be consumed.
any interface vtable for the interface, or the default vtable for the interface.
the #GParamSpec for the new property
Lists the properties of an interface.Generally, the interface
vtable passed in as g_iface will be the default vtable from
g_type_default_interface_ref(), or, if you know the interface has
already been loaded, g_type_default_interface_peek().
any interface vtable for the interface, or the default vtable for the interface
Returns the #GType of the setting's class for a given setting name.
a setting name
Returns the #GType of the setting's class for a given setting error quark. Useful for figuring out which setting a returned error is for.
a setting error quark
Creates a new object representing the remote connection.
a valid and connected D-Bus connection
the D-Bus path of the connection as exported by the settings service
Creates a new #NMConnection object with no #NMSetting objects.
Creates a new #NMConnection from a hash table describing the connection. See nm_connection_to_hash() for a description of the expected hash table.
the #GHashTable describing the connection
Creates a new instance of a #GObject subtype and sets its properties.
Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.
the type id of the #GObject subtype to instantiate
an array of #GParameter
Creates a new object representing the remote connection.