NMSettingBridge

NMSettingBridge — Describes connection properties for bridges

Synopsis


#include <nm-setting-bridge.h>

#define             NM_SETTING_BRIDGE_SETTING_NAME
enum                NMSettingBridgeError;
#define             NM_TYPE_SETTING_BRIDGE_ERROR
#define             NM_SETTING_BRIDGE_ERROR
GQuark              nm_setting_bridge_error_quark       (void);
#define             NM_SETTING_BRIDGE_INTERFACE_NAME
#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
#define             NM_SETTING_BRIDGE_MULTICAST_SNOOPING
                    NMSettingBridge;
GType               nm_setting_bridge_get_type          (void);
NMSetting *         nm_setting_bridge_new               (void);
const char *        nm_setting_bridge_get_interface_name
                                                        (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);
gboolean            nm_setting_bridge_get_multicast_snooping
                                                        (NMSettingBridge *setting);

Object Hierarchy

  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
  "max-age"                  guint                 : Read / Write / Construct
  "multicast-snooping"       gboolean              : 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

NM_TYPE_SETTING_BRIDGE_ERROR

#define NM_TYPE_SETTING_BRIDGE_ERROR (nm_setting_bridge_error_get_type ()) 


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.

NM_SETTING_BRIDGE_INTERFACE_NAME

#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"


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"


NM_SETTING_BRIDGE_MULTICAST_SNOOPING

#define NM_SETTING_BRIDGE_MULTICAST_SNOOPING "multicast-snooping"


NMSettingBridge

typedef struct _NMSettingBridge NMSettingBridge;


nm_setting_bridge_get_type ()

GType               nm_setting_bridge_get_type          (void);

Returns :


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.

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

nm_setting_bridge_get_stp ()

gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);

setting :

the NMSettingBridge

Returns :

the "stp" property of the setting

nm_setting_bridge_get_priority ()

guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);

setting :

the NMSettingBridge

Returns :

the "priority" property of the setting

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

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

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

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

nm_setting_bridge_get_multicast_snooping ()

gboolean            nm_setting_bridge_get_multicast_snooping
                                                        (NMSettingBridge *setting);

setting :

the NMSettingBridge

Returns :

the "multicast-snooping" property of the setting

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


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


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


The "interface-name" property

  "interface-name"           gchar*                : Read / Write

The name of the virtual in-kernel briding network interface

Default value: NULL


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


The "multicast-snooping" property

  "multicast-snooping"       gboolean              : Read / Write / Construct

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.

Default value: TRUE


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: 128


The "stp" property

  "stp"                      gboolean              : Read / Write / Construct

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

Default value: TRUE