NMSettingBridge

## NMSettingBridge NMSettingBridge — Describes connection properties for bridges |

## Synopsis

    #include <nm-setting-bridge.h>

    #define             NM_SETTING_BRIDGE_SETTING_NAME
    enum                NMSettingBridgeError;
    #define             NM_SETTING_BRIDGE_ERROR
    GQuark              nm_setting_bridge_error_quark       (void);
    #define             NM_SETTING_BRIDGE_INTERFACE_NAME
    #define             NM_SETTING_BRIDGE_MAC_ADDRESS
    #define             NM_SETTING_BRIDGE_STP
    #define             NM_SETTING_BRIDGE_PRIORITY
    #define             NM_SETTING_BRIDGE_FORWARD_DELAY
    #define             NM_SETTING_BRIDGE_HELLO_TIME
    #define             NM_SETTING_BRIDGE_MAX_AGE
    #define             NM_SETTING_BRIDGE_AGEING_TIME
                        NMSettingBridge;
                        NMSettingBridgeClass;
    NMSetting *         nm_setting_bridge_new               (void);
    const char *        nm_setting_bridge_get_interface_name
                                                            (NMSettingBridge *setting);
    const GByteArray *  nm_setting_bridge_get_mac_address   (NMSettingBridge *setting);
    gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
    guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
    guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
    guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
    guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);
    guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);

## Object Hierarchy

      GEnum
       +----NMSettingBridgeError

      GObject
       +----NMSetting
             +----NMSettingBridge

## Properties

      "ageing-time"              guint                 : Read / Write / Construct
      "forward-delay"            guint                 : Read / Write / Construct
      "hello-time"               guint                 : Read / Write / Construct
      "interface-name"           gchar*                : Read / Write
      "mac-address"              GArray_guchar_*       : Read / Write
      "max-age"                  guint                 : Read / Write / Construct
      "priority"                 guint                 : Read / Write / Construct
      "stp"                      gboolean              : Read / Write / Construct

## Description

The NMSettingBridge object is a NMSetting subclass that describes properties necessary for bridging connections.

## Details

### NM_SETTING_BRIDGE_SETTING_NAME

    #define NM_SETTING_BRIDGE_SETTING_NAME "bridge"

### enum NMSettingBridgeError

    typedef enum {
    	NM_SETTING_BRIDGE_ERROR_UNKNOWN = 0,      /*< nick=UnknownError >*/
    	NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
    	NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
    } NMSettingBridgeError;

`NM_SETTING_BRIDGE_ERROR_UNKNOWN` | unknown or unclassified error
`NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY` | the property was invalid
`NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY` | the property was missing and is required

Since 0.9.8

### NM_SETTING_BRIDGE_ERROR

    #define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark ()

### nm_setting_bridge_error_quark ()

    GQuark              nm_setting_bridge_error_quark       (void);

Registers an error quark for NMSettingBridge if necessary.

Returns : | the error quark used for NMSettingBridge errors.

Since 0.9.8

### NM_SETTING_BRIDGE_INTERFACE_NAME

    #define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"

### NM_SETTING_BRIDGE_MAC_ADDRESS

    #define NM_SETTING_BRIDGE_MAC_ADDRESS    "mac-address"

### NM_SETTING_BRIDGE_STP

    #define NM_SETTING_BRIDGE_STP            "stp"

### NM_SETTING_BRIDGE_PRIORITY

    #define NM_SETTING_BRIDGE_PRIORITY       "priority"

### NM_SETTING_BRIDGE_FORWARD_DELAY

    #define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"

### NM_SETTING_BRIDGE_HELLO_TIME

    #define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"

### NM_SETTING_BRIDGE_MAX_AGE

    #define NM_SETTING_BRIDGE_MAX_AGE        "max-age"

### NM_SETTING_BRIDGE_AGEING_TIME

    #define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"

### NMSettingBridge

    typedef struct _NMSettingBridge NMSettingBridge;

### NMSettingBridgeClass

    typedef struct {
    	NMSettingClass parent;

    	/* Padding for future expansion */
    	void (*_reserved1) (void);
    	void (*_reserved2) (void);
    	void (*_reserved3) (void);
    	void (*_reserved4) (void);
    } NMSettingBridgeClass;

### nm_setting_bridge_new ()

    NMSetting *         nm_setting_bridge_new               (void);

Creates a new NMSettingBridge object with default values.

Returns : | the new empty NMSettingBridge object. [transfer full]

Since 0.9.8

### nm_setting_bridge_get_interface_name ()

    const char *        nm_setting_bridge_get_interface_name
                                                            (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "interface-name" property of the setting

Since 0.9.8

### nm_setting_bridge_get_mac_address ()

    const GByteArray *  nm_setting_bridge_get_mac_address   (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "mac-address" property of the setting

Since 0.9.10

### nm_setting_bridge_get_stp ()

    gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "stp" property of the setting

Since 0.9.8

### nm_setting_bridge_get_priority ()

    guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "priority" property of the setting

Since 0.9.8

### nm_setting_bridge_get_forward_delay ()

    guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "forward-delay" property of the setting

Since 0.9.8

### nm_setting_bridge_get_hello_time ()

    guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "hello-time" property of the setting

Since 0.9.8

### nm_setting_bridge_get_max_age ()

    guint16             nm_setting_bridge_get_max_age       (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "max-age" property of the setting

Since 0.9.8

### nm_setting_bridge_get_ageing_time ()

    guint32             nm_setting_bridge_get_ageing_time   (NMSettingBridge *setting);

`setting` : | the NMSettingBridge
Returns : | the "ageing-time" property of the setting

Since 0.9.8

## Property Details

### The `"ageing-time"` property

      "ageing-time"              guint                 : Read / Write / Construct

The Ethernet MAC address aging time, in seconds.

Allowed values: <= 1000000

Default value: 300

Since 0.9.8

### The `"forward-delay"` property

      "forward-delay"            guint                 : Read / Write / Construct

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

Allowed values: <= 30

Default value: 15

Since 0.9.8

### The `"hello-time"` property

      "hello-time"               guint                 : Read / Write / Construct

The Spanning Tree Protocol (STP) hello time, in seconds.

Allowed values: <= 10

Default value: 2

Since 0.9.8

### The `"interface-name"` property

      "interface-name"           gchar*                : Read / Write

The name of the virtual in-kernel bridging network interface

Default value: NULL

Since 0.9.8

### The `"mac-address"` property

      "mac-address"              GArray_guchar_*       : Read / Write

If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match.

Since 0.9.10

### The `"max-age"` property

      "max-age"                  guint                 : Read / Write / Construct

The Spanning Tree Protocol (STP) maximum message age, in seconds.

Allowed values: <= 40

Default value: 20

Since 0.9.8

### The `"priority"` property

      "priority"                 guint                 : Read / Write / Construct

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

Allowed values: <= 65535

Default value: 32768

Since 0.9.8

### The `"stp"` property

      "stp"                      gboolean              : Read / Write / Construct

Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.

Default value: TRUE

Since 0.9.8