Class (GI Class)

NM-1.0NMSettingBridge

Bridging Settings

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Accessors - Inherited from NM.Setting

Methods

Methods - Inherited from NM.Setting

Constructors

Properties

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

Accessors

  • get forward_delay(): number

    The Spanning Tree Protocol (STP) forwarding delay, in seconds.

    Returns number

  • set forward_delay(val: number): void

    Parameters

    • val: number

    Returns void

  • get forwardDelay(): number

    The Spanning Tree Protocol (STP) forwarding delay, in seconds.

    Returns number

  • set forwardDelay(val: number): void

    Parameters

    • val: number

    Returns void

  • get group_address(): string

    If specified, The MAC address of the multicast group this bridge uses for STP.

    The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.

    Returns string

    1.24

  • set group_address(val: string): void

    Parameters

    • val: string

    Returns void

  • get group_forward_mask(): number

    A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.

    Returns number

    1.10

  • set group_forward_mask(val: number): void

    Parameters

    • val: number

    Returns void

  • get groupAddress(): string

    If specified, The MAC address of the multicast group this bridge uses for STP.

    The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.

    Returns string

    1.24

  • set groupAddress(val: string): void

    Parameters

    • val: string

    Returns void

  • get groupForwardMask(): number

    A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.

    Returns number

    1.10

  • set groupForwardMask(val: number): void

    Parameters

    • val: number

    Returns void

  • get mac_address(): string

    If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.

    If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.

    Returns string

    since 1.12: Use the NM.SettingWired.cloned_mac_address property instead.

  • set mac_address(val: string): void

    Parameters

    • val: string

    Returns void

  • get macAddress(): string

    If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.

    If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.

    Returns string

    since 1.12: Use the NM.SettingWired.cloned_mac_address property instead.

  • set macAddress(val: string): void

    Parameters

    • val: string

    Returns void

  • get multicast_hash_max(): number

    Set maximum size of multicast hash table (value must be a power of 2).

    Returns number

  • set multicast_hash_max(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_last_member_count(): number

    Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.

    Returns number

  • set multicast_last_member_count(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_last_member_interval(): number

    Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.

    Returns number

  • set multicast_last_member_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_membership_interval(): number

    Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.

    Returns number

  • set multicast_membership_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_querier(): boolean

    Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.

    Returns boolean

  • set multicast_querier(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicast_querier_interval(): number

    If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.

    Returns number

  • set multicast_querier_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_query_interval(): number

    Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.

    Returns number

  • set multicast_query_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_query_response_interval(): number

    Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.

    Returns number

  • set multicast_query_response_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_query_use_ifaddr(): boolean

    If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.

    Returns boolean

  • set multicast_query_use_ifaddr(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicast_router(): string

    Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.

    Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).

    Returns string

  • set multicast_router(val: string): void

    Parameters

    • val: string

    Returns void

  • get multicast_snooping(): boolean

    Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.

    Returns boolean

    1.2

  • set multicast_snooping(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicast_startup_query_count(): number

    Set the number of IGMP queries to send during startup phase.

    Returns number

  • set multicast_startup_query_count(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicast_startup_query_interval(): number

    Sets the time (in deciseconds) between queries sent out at startup to determine membership information.

    Returns number

  • set multicast_startup_query_interval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastHashMax(): number

    Set maximum size of multicast hash table (value must be a power of 2).

    Returns number

  • set multicastHashMax(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastLastMemberCount(): number

    Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.

    Returns number

  • set multicastLastMemberCount(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastLastMemberInterval(): number

    Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.

    Returns number

  • set multicastLastMemberInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastMembershipInterval(): number

    Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.

    Returns number

  • set multicastMembershipInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastQuerier(): boolean

    Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.

    Returns boolean

  • set multicastQuerier(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicastQuerierInterval(): number

    If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.

    Returns number

  • set multicastQuerierInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastQueryInterval(): number

    Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.

    Returns number

  • set multicastQueryInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastQueryResponseInterval(): number

    Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.

    Returns number

  • set multicastQueryResponseInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastQueryUseIfaddr(): boolean

    If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.

    Returns boolean

  • set multicastQueryUseIfaddr(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicastRouter(): string

    Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.

    Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).

    Returns string

  • set multicastRouter(val: string): void

    Parameters

    • val: string

    Returns void

  • get multicastSnooping(): boolean

    Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.

    Returns boolean

    1.2

  • set multicastSnooping(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get multicastStartupQueryCount(): number

    Set the number of IGMP queries to send during startup phase.

    Returns number

  • set multicastStartupQueryCount(val: number): void

    Parameters

    • val: number

    Returns void

  • get multicastStartupQueryInterval(): number

    Sets the time (in deciseconds) between queries sent out at startup to determine membership information.

    Returns number

  • set multicastStartupQueryInterval(val: number): void

    Parameters

    • val: number

    Returns void

  • get priority(): number

    Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.

    Returns number

  • set priority(val: number): void

    Parameters

    • val: number

    Returns void

  • get vlan_default_pvid(): number

    The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.

    Returns number

    1.18

  • set vlan_default_pvid(val: number): void

    Parameters

    • val: number

    Returns void

  • get vlan_filtering(): boolean

    Control whether VLAN filtering is enabled on the bridge.

    Returns boolean

    1.18

  • set vlan_filtering(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get vlan_protocol(): string

    If specified, the protocol used for VLAN filtering.

    Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

    Returns string

    1.24

  • set vlan_protocol(val: string): void

    Parameters

    • val: string

    Returns void

  • get vlan_stats_enabled(): boolean

    Controls whether per-VLAN stats accounting is enabled.

    Returns boolean

  • set vlan_stats_enabled(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get vlanDefaultPvid(): number

    The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.

    Returns number

    1.18

  • set vlanDefaultPvid(val: number): void

    Parameters

    • val: number

    Returns void

  • get vlanFiltering(): boolean

    Control whether VLAN filtering is enabled on the bridge.

    Returns boolean

    1.18

  • set vlanFiltering(val: boolean): void

    Parameters

    • val: boolean

    Returns void

  • get vlanProtocol(): string

    If specified, the protocol used for VLAN filtering.

    Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.

    Returns string

    1.24

  • set vlanProtocol(val: string): void

    Parameters

    • val: string

    Returns void

  • get vlans(): BridgeVlan[]

    Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.

    In nmcli the VLAN list can be specified with the following syntax:

    $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...

    where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.

    Returns BridgeVlan[]

    1.18

  • set vlans(val: BridgeVlan[]): void

    Parameters

    Returns void

  • get vlanStatsEnabled(): boolean

    Controls whether per-VLAN stats accounting is enabled.

    Returns boolean

  • set vlanStatsEnabled(val: boolean): void

    Parameters

    • val: boolean

    Returns void

Accessors - Inherited from NM.Setting

  • get name(): string

    The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "802-11-wireless" or "802-3-ethernet".

    Returns string

Methods

  • Appends a new vlan and associated information to the setting. The given vlan gets sealed and a reference to it is added.

    Parameters

    Returns void

  • Removes the vlan at index idx.

    Parameters

    • idx: number

      index number of the VLAN.

    Returns void

  • Remove the VLAN with range vid_start to vid_end. If vid_end is zero, it is assumed to be equal to vid_start and so the single-id VLAN with id vid_start is removed.

    Parameters

    • vid_start: number

      the vlan start index

    • vid_end: number

      the vlan end index

    Returns boolean

    true if the vlan was found and removed; false otherwise

Methods - Inherited from NM.Setting

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target GObject.Object

    • target_property: string

      the property on target to bind

    • flags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • Optionaltransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • Optionaltransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • Optionalnotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

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

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Compares two NM.Setting objects for similarity, with comparison behavior modified by a set of flags. See the documentation for NM.SettingCompareFlags for a description of each flag's behavior. If the settings differ, the keys of each setting that differ from the other are added to results, mapped to one or more NM.SettingDiffResult values.

    Parameters

    • b: NM.Setting

      a second NM.Setting to compare with the first

    • flags: NM.SettingCompareFlags

      compare flags, e.g. NM.SettingCompareFlags.EXACT

    • invert_results: boolean

      this parameter is used internally by libnm and should be set to false. If true inverts the meaning of the NM.SettingDiffResult.

    • results: GLib.HashTable<string, number> | { [key: string]: any }

      if the settings differ, on return a hash table mapping the differing keys to one or more %NMSettingDiffResult values OR-ed together. If the settings do not differ, any hash table passed in is unmodified. If no hash table is passed in and the settings differ, a new one is created and returned.

    Returns [boolean, GLib.HashTable<string, number>]

    true if the settings contain the same values, false if they do not

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • id: number

      Handler ID of the handler to be disconnected

    Returns void

  • This function is intended for GObject.Object implementations to re-enforce a floating 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().

    Returns void

  • 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.Object::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.

    Returns void

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • key: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • property_name: string

      The name of the property to get

    • value: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

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

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

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

    Parameters

    • property_name: string

      the name of a property installed on the class of object.

    Returns void

  • 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.:

      typedef enum
    {
    PROP_FOO = 1,
    PROP_LAST
    } MyObjectProperty;

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
    0, 100,
    50,
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    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]);
    

    Parameters

    Returns void

  • Gives the name of all set options.

    Returns string[]

    A null terminated array of key names. If no names are present, this returns null. The returned array and the names are owned by %NMSetting and might be invalidated by the next operation.

  • Parameters

    • opt_name: string

      the option to get

    Returns [boolean, boolean]

    true if opt_name is set to a boolean variant.

  • Parameters

    • opt_name: string

      the option to get

    Returns [boolean, number]

    true if opt_name is set to a uint32 variant.

  • If variant is null, this clears the option if it is set. Otherwise, variant is set as the option. If variant is a floating reference, it will be consumed.

    Note that not all setting types support options. It is a bug setting a variant to a setting that doesn't support it. Currently, only NM.SettingEthtool supports it.

    Parameters

    • opt_name: string

      the option name to set

    • Optionalvariant: GLib.Variant<any>

      the variant to set.

    Returns void

  • Like nm_setting_option_set() to set a boolean GVariant.

    Parameters

    • opt_name: string
    • value: boolean

      the value to set.

    Returns void

  • Like nm_setting_option_set() to set a uint32 GVariant.

    Parameters

    • opt_name: string
    • value: number

      the value to set.

    Returns void

  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

    the same object

  • Increase the reference count of object, and possibly remove the floating 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().

    Returns GObject.Object

    object

  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

    Parameters

    • properties: { [key: string]: any }

      Object containing the properties to set

    Returns void

  • 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optionaldata: any

      data to associate with that key

    Returns void

  • Sets a property on an object.

    Parameters

    • property_name: string

      The name of the property to set

    • value: any

      The value to set the property to

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • key: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

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

    Parameters

    • quark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

  • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

    Parameters

    • detailedName: string

      Name of the signal to stop emission of

    Returns void

  • 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.Object::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.

    Returns void

  • Convert the setting (including secrets!) into a string. For debugging purposes ONLY, should NOT be used for serialization of the setting, or machine-parsed in any way. The output format is not guaranteed to be stable and may change at any time.

    Returns string

    an allocated string containing a textual representation of the setting's properties and values, which the caller should free with g_free()

  • 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.Object 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.Object instance. Use g_clear_object() for this.

    Returns void

  • Validates the setting. Each setting's properties have allowed values, and some are dependent on other values (hence the need for connection). The returned GLib.Error contains information about which property of the setting failed validation, and in what way that property failed validation.

    Parameters

    • Optionalconnection: NM.Connection

      the NM.Connection that setting came from, or null if setting is being verified in isolation.

    Returns boolean

    true if the setting is valid, false if it is not

  • Verifies the secrets in the setting. The returned GLib.Error contains information about which secret of the setting failed validation, and in what way that secret failed validation. The secret validation is done separately from main setting validation, because in some cases connection failure is not desired just for the secrets.

    Parameters

    • Optionalconnection: NM.Connection

      the NM.Connection that setting came from, or null if setting is being verified in isolation.

    Returns boolean

    true if the setting secrets are valid, false if they are not

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

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

    Parameters

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    Returns void

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

    Parameters

    Returns void

  • Get the type of the enum that defines the values that the property accepts. It is only useful for properties configured to accept values from certain enum type, otherwise it will return G_TYPE_INVALID. Note that flags (children of G_TYPE_FLAGS) are also considered enums.

    Note that the GObject property might be implemented as an integer, actually, and not as enum. Find out what underlying type is used, checking the GObject.ParamSpec, before setting the GObject property.

    Parameters

    • setting_type: GType

      the GType of the NMSetting instance

    • property_name: string

      the name of the property

    Returns GType

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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.

    Parameters

    Returns void

  • Parameters

    • property_id: number

      the new property ID

    • name: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures