libnm-util Reference Manual: NMSettingBridge

@@ -31,604 +37,521 @@

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
+

Functions

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;
+

--++ - - - - - - - - - - + - - + - - - - - - - - - - - - - - - - - - +

-GQuark -	-nm_setting_bridge_error_quark () -
-NMSetting * -	-nm_setting_bridge_new () -
const char * -	-nm_setting_bridge_get_interface_name () +	`NM_SETTING_BRIDGE_ERROR_UNKNOWN`	unknown or unclassified error
-gboolean -	-nm_setting_bridge_get_stp () +	`NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY`	the property was invalid
-guint16 -	-nm_setting_bridge_get_priority () -
-guint16 -	-nm_setting_bridge_get_forward_delay () -
-guint16 -	-nm_setting_bridge_get_hello_time () -
-guint16 -	-nm_setting_bridge_get_max_age () -
-guint32 -	-nm_setting_bridge_get_ageing_time () +	`NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY`	the property was missing and is +required

Since 0.9.8

Properties

----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

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

NM_SETTING_BRIDGE_ERROR

#define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark ()
+

Types and Values

nm_setting_bridge_error_quark ()

GQuark              nm_setting_bridge_error_quark       (void);

+Registers an error quark for NMSettingBridge if necessary. +

--++ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +

#define	NM_SETTING_BRIDGE_SETTING_NAME
enum	NMSettingBridgeError
#define	NM_SETTING_BRIDGE_ERROR
#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
Returns :	the error quark used for NMSettingBridge errors.

Since 0.9.8

Object Hierarchy

    GEnum
-    ╰── NMSettingBridgeError
-    GObject
-    ╰── NMSetting
-        ╰── NMSettingBridge
+
+
+NM_SETTING_BRIDGE_INTERFACE_NAME
+#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
 
+
+
 
-
-Includes
-#include <nm-setting-bridge.h>
+
+
+NM_SETTING_BRIDGE_MAC_ADDRESS
+#define NM_SETTING_BRIDGE_MAC_ADDRESS    "mac-address"
 
+
+
 
-
-Description
-The NMSettingBridge object is a NMSetting subclass that describes properties
-necessary for bridging connections.
+
+
+NM_SETTING_BRIDGE_STP
+#define NM_SETTING_BRIDGE_STP            "stp"
+
+
+
 
-
-Functions
+
 
-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_PRIORITY
+#define NM_SETTING_BRIDGE_PRIORITY       "priority"
+
+
+
 
-Since 0.9.8
+
+
+NM_SETTING_BRIDGE_FORWARD_DELAY
+#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
+
+
+
 
 
 
-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_HELLO_TIME
+#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
+
+
+
 
-Since 0.9.8
+
+
+NM_SETTING_BRIDGE_MAX_AGE
+#define NM_SETTING_BRIDGE_MAX_AGE        "max-age"
+
+
+
 
 
 
-nm_setting_bridge_get_interface_name ()
-const char *
-nm_setting_bridge_get_interface_name (NMSettingBridge *setting);
-
-Parameters
-
-----
-
-
-
-
-
-



setting the NMSettingBridge  
+NM_SETTING_BRIDGE_AGEING_TIME
+#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
+
+
+
 
-
-Returns
- the “interface-name” property of the setting
-
+
+
+NMSettingBridge
+typedef struct _NMSettingBridge NMSettingBridge;
+
+
 
-Since 0.9.8
+
+
+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_get_stp ()
-gboolean
-nm_setting_bridge_get_stp (NMSettingBridge *setting);
-
-Parameters
-
+nm_setting_bridge_new ()
+NMSetting *         nm_setting_bridge_new               (void);
+
+Creates a new NMSettingBridge object with default values.
+
+
---++
-
-
-
+
+
 





 
 setting the NMSettingBridge   Returns : the new empty NMSettingBridge object. [transfer full]
+
 
 
-
-
-Returns
- the “stp” property of the setting
-
-
 Since 0.9.8
 
 
 
-nm_setting_bridge_get_priority ()
-guint16
-nm_setting_bridge_get_priority (NMSettingBridge *setting);
-
-Parameters
-
+nm_setting_bridge_get_interface_name ()
+const char *        nm_setting_bridge_get_interface_name
+                                                        (NMSettingBridge *setting);
+
---++
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 





 setting the NMSettingBridge  
setting : the NMSettingBridge
+
Returns : the "interface-name" property of the setting
 
-
-
-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);
-
-Parameters
-
+nm_setting_bridge_get_mac_address ()
+const GByteArray *  nm_setting_bridge_get_mac_address   (NMSettingBridge *setting);
+
---++
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 





 setting the NMSettingBridge  
setting : the NMSettingBridge
+
Returns : the "mac-address" property of the setting
 
-
-
-Returns
- the “forward-delay” property of the setting
-
-
-Since 0.9.8
+Since 0.9.10
 
 
 
-nm_setting_bridge_get_hello_time ()
-guint16
-nm_setting_bridge_get_hello_time (NMSettingBridge *setting);
-
-Parameters
-
+nm_setting_bridge_get_stp ()
+gboolean            nm_setting_bridge_get_stp           (NMSettingBridge *setting);
+
---++
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 





 setting the NMSettingBridge  
setting : the NMSettingBridge
+
Returns : the "stp" property of the setting
 
-
-
-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);
-
-Parameters
-
+nm_setting_bridge_get_priority ()
+guint16             nm_setting_bridge_get_priority      (NMSettingBridge *setting);
+
---++
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 





 setting the NMSettingBridge  
setting : the NMSettingBridge
+
Returns : the "priority" property of the setting
 
-
-
-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);
-
-Parameters
-
+nm_setting_bridge_get_forward_delay ()
+guint16             nm_setting_bridge_get_forward_delay (NMSettingBridge *setting);
+
---++
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
 





 setting the NMSettingBridge  
setting : the NMSettingBridge
+
Returns : the "forward-delay" property of the setting
 
-
-
-Returns
- the “ageing-time” property of the setting
-
-
 Since 0.9.8
 
-
-
-Types and Values
-
-NM_SETTING_BRIDGE_SETTING_NAME
-#define NM_SETTING_BRIDGE_SETTING_NAME "bridge"
-
-
-
-
 
 
-enum NMSettingBridgeError
-
-Members
-
+nm_setting_bridge_get_hello_time ()
+guint16             nm_setting_bridge_get_hello_time    (NMSettingBridge *setting);
+
---++
-
-
+
-
-
-
-
+
+
+
+
 





 
 
 NM_SETTING_BRIDGE_ERROR_UNKNOWN 
-unknown or unclassified error
+ setting : the NMSettingBridge
  
 
 NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY 
-the property was invalid
-   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);
+
++++
+
-
-
+
-
+
+
+
+



 NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY 
-the property was missing and is
-required
+ setting : the NMSettingBridge
  
Returns : the "max-age" property of the setting
 
 
 
-
 Since 0.9.8
 
 
 
-NM_SETTING_BRIDGE_ERROR
-#define NM_SETTING_BRIDGE_ERROR nm_setting_bridge_error_quark ()
-
-
-
+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
 
-
-
-NM_SETTING_BRIDGE_INTERFACE_NAME
-#define NM_SETTING_BRIDGE_INTERFACE_NAME "interface-name"
-
-
-
 
-
+
+Property Details
 
-NM_SETTING_BRIDGE_STP
-#define NM_SETTING_BRIDGE_STP            "stp"
-
+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
 
 
 
-NM_SETTING_BRIDGE_PRIORITY
-#define NM_SETTING_BRIDGE_PRIORITY       "priority"
-
+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
 
 
 
-NM_SETTING_BRIDGE_FORWARD_DELAY
-#define NM_SETTING_BRIDGE_FORWARD_DELAY  "forward-delay"
-
+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
 
 
 
-NM_SETTING_BRIDGE_HELLO_TIME
-#define NM_SETTING_BRIDGE_HELLO_TIME     "hello-time"
-
+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
 
 
 
-NM_SETTING_BRIDGE_MAX_AGE
-#define NM_SETTING_BRIDGE_MAX_AGE        "max-age"
-
+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
 
 
 
-NM_SETTING_BRIDGE_AGEING_TIME
-#define NM_SETTING_BRIDGE_AGEING_TIME    "ageing-time"
-
+The "max-age" property
+  "max-age"                  guint                 : Read / Write / Construct
 
+The Spanning Tree Protocol (STP) maximum message age, in seconds.
 
-
-
-
-Property Details
-
-The “ageing-time” property
-  “ageing-time”              guint
-The ethernet MAC address aging time, in seconds.
-Flags: Read / Write / Construct
-Allowed values: <= 1000000
-Default value: 300
-Since 0.9.8
-
-
-
-The “forward-delay” property
-  “forward-delay”            guint
-The Spanning Tree Protocol (STP) forwarding delay, in seconds.
-Flags: Read / Write / Construct
-Allowed values: <= 30
-Default value: 15
-Since 0.9.8
-
-
-
-The “hello-time” property
-  “hello-time”               guint
-The Spanning Tree Protocol (STP) hello time, in seconds.
-Flags: Read / Write / Construct
-Allowed values: <= 10
-Default value: 2
-Since 0.9.8
-
-
-
-The “interface-name” property
-  “interface-name”           gchar *
-The name of the virtual in-kernel bridging network interface.
-Flags: Read / Write
-Default value: NULL
-Since 0.9.8
-
-
-
-The “max-age” property
-  “max-age”                  guint
-The Spanning Tree Protocol (STP) maximum message age, in seconds.
-Flags: Read / Write / Construct
 Allowed values: <= 40
 Default value: 20
 Since 0.9.8
 
 
 
-The “priority” property
-  “priority”                 guint
-Sets the Spanning Tree Protocol (STP) priority for this bridge.  Lower values are 'better'; the lowest priority bridge will be elected the root bridge.
-Flags: Read / Write / Construct
+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
-Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.
-Flags: Read / Write / Construct
+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
 
@@ -636,6 +559,6 @@ required
 
 
 
-          Generated by GTK-Doc V1.20
+          Generated by GTK-Doc V1.19
 
 
\ No newline at end of file
-- 
cgit 1.3.0-6-gf8a5

			libnm-util Reference Manual
+Top + \| + Description + \| + Object Hierarchy + \| + Properties +

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

NM_SETTING_BRIDGE_ERROR_UNKNOWN	- unknown or unclassified error +	`setting` :	the NMSettingBridge
NM_SETTING_BRIDGE_ERROR_INVALID_PROPERTY	- the property was invalid -		Returns :	the "hello-time" property of the setting

NM_SETTING_BRIDGE_ERROR_MISSING_PROPERTY	- the property was missing and is -required +	`setting` :	the NMSettingBridge
Returns :	the "max-age" property of the setting