NMSettingVlan

@@ -37,822 +31,992 @@

NMSettingVlan

NMSettingVlan — Describes connection properties for VLAN interfaces

- +

Synopsis

-#include <nm-setting-vlan.h>
-
-#define             NM_SETTING_VLAN_SETTING_NAME
-enum                NMSettingVlanError;
-#define             NM_SETTING_VLAN_ERROR
-GQuark              nm_setting_vlan_error_quark         (void);
-#define             NM_SETTING_VLAN_INTERFACE_NAME
-#define             NM_SETTING_VLAN_PARENT
-#define             NM_SETTING_VLAN_ID
-#define             NM_SETTING_VLAN_FLAGS
-#define             NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
-#define             NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
-                    NMSettingVlan;
-                    NMSettingVlanClass;
-enum                NMVlanPriorityMap;
-enum                NMVlanFlags;
-NMSetting *         nm_setting_vlan_new                 (void);
-const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
-const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-gint32              nm_setting_vlan_get_num_priorities  (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx,
-                                                         guint32 *out_from,
-                                                         guint32 *out_to);
-gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-void                nm_setting_vlan_remove_priority     (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx);
-gboolean            nm_setting_vlan_remove_priority_by_value
-                                                        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-gboolean            nm_setting_vlan_remove_priority_str_by_value
-                                                        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-

Object Hierarchy

-  GEnum
-   +----NMSettingVlanError
-

-  GObject
-   +----NMSetting
-         +----NMSettingVlan
-

-  GEnum
-   +----NMVlanPriorityMap
-

-  GEnum
-   +----NMVlanFlags
-

Properties

-  "egress-priority-map"      GSList_gchararray_*   : Read / Write
-  "flags"                    guint                 : Read / Write / Construct
-  "id"                       guint                 : Read / Write / Construct
-  "ingress-priority-map"     GSList_gchararray_*   : Read / Write
-  "interface-name"           gchar*                : Read / Write / Construct
-  "parent"                   gchar*                : Read / Write / Construct
-

Description

-The NMSettingVlan object is a NMSetting subclass that describes properties -necessary for connection to VLAN interfaces. -

Details

NM_SETTING_VLAN_SETTING_NAME

#define NM_SETTING_VLAN_SETTING_NAME "vlan"
-

enum NMSettingVlanError

typedef enum {
-	NM_SETTING_VLAN_ERROR_UNKNOWN = 0,      /*< nick=Unknown >*/
-	NM_SETTING_VLAN_ERROR_INVALID_PROPERTY, /*< nick=InvalidProperty >*/
-	NM_SETTING_VLAN_ERROR_MISSING_PROPERTY, /*< nick=MissingProperty >*/
-	NM_SETTING_VLAN_ERROR_INVALID_PARENT    /*< nick=InvalidParent >*/
-} NMSettingVlanError;
-

Functions

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

`NM_SETTING_VLAN_ERROR_UNKNOWN`	unknown or unclassified error +	+GQuark +	+nm_setting_vlan_error_quark () +
+NMSetting * +	+nm_setting_vlan_new () +
const char * +	+nm_setting_vlan_get_interface_name () +
const char * +	+nm_setting_vlan_get_parent () +
+guint32 +	+nm_setting_vlan_get_id () +
+guint32 +	+nm_setting_vlan_get_flags ()
`NM_SETTING_VLAN_ERROR_INVALID_PROPERTY`	the property was invalid +	+gint32 +	+nm_setting_vlan_get_num_priorities ()
`NM_SETTING_VLAN_ERROR_MISSING_PROPERTY`	the property was missing and is - required +	+gboolean +	+nm_setting_vlan_get_priority ()
`NM_SETTING_VLAN_ERROR_INVALID_PARENT`	the VLAN parent was specified - inconsistently +	+gboolean +	+nm_setting_vlan_add_priority () +
+void +	+nm_setting_vlan_remove_priority () +
+gboolean +	+nm_setting_vlan_remove_priority_by_value () +
+gboolean +	+nm_setting_vlan_remove_priority_str_by_value () +
+void +	+nm_setting_vlan_clear_priorities () +
+gboolean +	+nm_setting_vlan_add_priority_str ()

NM_SETTING_VLAN_ERROR

#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
-

Properties

+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+GSList_gchararray_ *	egress-priority-map	Read / Write
guint	flags	Read / Write / Construct
guint	id	Read / Write / Construct
+GSList_gchararray_ *	ingress-priority-map	Read / Write
+gchar *	interface-name	Read / Write / Construct
+gchar *	parent	Read / Write / Construct

nm_setting_vlan_error_quark ()

GQuark              nm_setting_vlan_error_quark         (void);

-Registers an error quark for NMSettingVlan if necessary. -

Types and Values

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

Returns :	the error quark used for NMSettingVlan errors.
#define	NM_SETTING_VLAN_SETTING_NAME
enum	NMSettingVlanError
#define	NM_SETTING_VLAN_ERROR
#define	NM_SETTING_VLAN_INTERFACE_NAME
#define	NM_SETTING_VLAN_PARENT
#define	NM_SETTING_VLAN_ID
#define	NM_SETTING_VLAN_FLAGS
#define	NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
#define	NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
enum	NMVlanPriorityMap
enum	NMVlanFlags

NM_SETTING_VLAN_INTERFACE_NAME

#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
+
+Object Hierarchy
+    GEnum
+    ├── NMSettingVlanError
+    ├── NMVlanFlags
+    ╰── NMVlanPriorityMap
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingVlan
 
-
-
 
-
-
-NM_SETTING_VLAN_PARENT
-#define NM_SETTING_VLAN_PARENT               "parent"
+
+Includes
+#include <nm-setting-vlan.h>
 
-
-
 
-
-
-NM_SETTING_VLAN_ID
-#define NM_SETTING_VLAN_ID                   "id"
-
-
-
+
+Description
+The NMSettingVlan object is a NMSetting subclass that describes properties
+necessary for connection to VLAN interfaces.
 
-
+
+Functions
 
-NM_SETTING_VLAN_FLAGS
-#define NM_SETTING_VLAN_FLAGS                "flags"
-
-
-
+nm_setting_vlan_error_quark ()
+GQuark
+nm_setting_vlan_error_quark (void);
+Registers an error quark for NMSettingVlan if necessary.
+
+Returns
+ the error quark used for NMSettingVlan errors.
+
 
-
-
-NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
-#define NM_SETTING_VLAN_INGRESS_PRIORITY_MAP "ingress-priority-map"
-
-
-
 
 
 
-NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
-#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
-
-
-
+nm_setting_vlan_new ()
+NMSetting *
+nm_setting_vlan_new (void);
+Creates a new NMSettingVlan object with default values.
+
+Returns
+ the new empty NMSettingVlan object. 
+[transfer full]
 
-
-
-NMSettingVlan
-typedef struct _NMSettingVlan NMSettingVlan;
-
-
 
 
 
-NMSettingVlanClass
-typedef struct {
-	NMSettingClass parent;
-
-	/* Padding for future expansion */
-	void (*_reserved1) (void);
-	void (*_reserved2) (void);
-	void (*_reserved3) (void);
-	void (*_reserved4) (void);
-} NMSettingVlanClass;
-
-
-
+nm_setting_vlan_get_interface_name ()
+const char *
+nm_setting_vlan_get_interface_name (NMSettingVlan *setting);
+
+Parameters
+
+++++
+
+
+
+
+
+



setting the NMSettingVlan  
+
+
+Returns
+ the “interface_name” property of the setting
+
+
 
 
 
-enum NMVlanPriorityMap
-typedef enum {
-	NM_VLAN_INGRESS_MAP,
-	NM_VLAN_EGRESS_MAP
-} NMVlanPriorityMap;
-
-
-A selector for traffic priority maps; these map Linux SKB priorities
-to 802.1p priorities used in VLANs.
-
-
+nm_setting_vlan_get_parent ()
+const char *
+nm_setting_vlan_get_parent (NMSettingVlan *setting);
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 NM_VLAN_INGRESS_MAP map for incoming data
-
NM_VLAN_EGRESS_MAP map for outgoing data
-
setting the NMSettingVlan  
 
 
+
+Returns
+ the “parent” property of the setting
+
+
+
 
 
-enum NMVlanFlags
-typedef enum {
-	NM_VLAN_FLAG_REORDER_HEADERS = 0x1,
-	NM_VLAN_FLAG_GVRP            = 0x2,
-	NM_VLAN_FLAG_LOOSE_BINDING   = 0x4,
-
-	/* NOTE: if adding flags update nm-setting-vlan.c::verify() */
-} NMVlanFlags;
-
-
-NMVlanFlags values control the behavior of the VLAN interface.
-
-
+nm_setting_vlan_get_id ()
+guint32
+nm_setting_vlan_get_id (NMSettingVlan *setting);
+
+Parameters
+
--+++
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
 





 NM_VLAN_FLAG_REORDER_HEADERS indicates that this interface should reorder
- outgoing packet headers to look more like a non-VLAN Ethernet interface
-
NM_VLAN_FLAG_GVRP indicates that this interface should use GVRP to register
- itself with it's switch
-
NM_VLAN_FLAG_LOOSE_BINDING indicates that this interface's operating
- state is tied to the underlying network interface but other details
- (like routing) are not.
-
setting the NMSettingVlan  
 
 
+
+Returns
+ the “id” property of the setting
+
+
+
 
 
-nm_setting_vlan_new ()
-NMSetting *         nm_setting_vlan_new                 (void);
-
-Creates a new NMSettingVlan object with default values.
-
-
+nm_setting_vlan_get_flags ()
+guint32
+nm_setting_vlan_get_flags (NMSettingVlan *setting);
+
+Parameters
+
--+++
-
-
+
+
+
 





 
 Returns : the new empty NMSettingVlan object. [transfer full]
- setting the NMSettingVlan  
 
 
 
+
+Returns
+ the “flags” property of the setting
+
+
+
 
 
-nm_setting_vlan_get_interface_name ()
-const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
-
+nm_setting_vlan_get_num_priorities ()
+gint32
+nm_setting_vlan_get_num_priorities (NMSettingVlan *setting,
+                                    NMVlanPriorityMap map);
+Returns the number of entires in the
+“ingress_priority_map” or “egress_priority_map”
+properties of this setting.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
 





 
 
 setting : the NMSettingVlan
- setting the NMSettingVlan  
 
 Returns : the "interface_name" property of the setting map the type of priority map  
 
 
 
 
+
+Returns
+ return the number of ingress/egress priority entries, -1 if error
+
+
+
 
 
-nm_setting_vlan_get_parent ()
-const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
-
+nm_setting_vlan_get_priority ()
+gboolean
+nm_setting_vlan_get_priority (NMSettingVlan *setting,
+                              NMVlanPriorityMap map,
+                              guint32 idx,
+                              guint32 *out_from,
+                              guint32 *out_to);
+Retrieve one of the entries of the “ingress_priority_map”
+or “egress_priority_map” properties of this setting.
+
+Parameters
+
--+++
-
-
+
+
+
-
-
+
+
+
-
-
 





 
 
 setting : the NMSettingVlan
- setting the NMSettingVlan  
 
 Returns : the "parent" property of the setting map the type of priority map  
 
-
-
-
-nm_setting_vlan_get_id ()
-guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
-
----
-
-
-
+
+
+
+
+
+
+
+
-
-
+
+
+



 setting : the NMSettingVlan
- idx the zero-based index of the ingress/egress priority map entry  
out_from  on return the value of the priority map's 'from' item. [out]
 
 Returns : the "id" property of the setting out_to  on return the value of priority map's 'to' item. [out]
 
 
 
 
+
+Returns
+ TRUE if a priority map was returned, FALSE if error
+
+
+
 
 
-nm_setting_vlan_get_flags ()
-guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-
+nm_setting_vlan_add_priority ()
+gboolean
+nm_setting_vlan_add_priority (NMSettingVlan *setting,
+                              NMVlanPriorityMap map,
+                              guint32 from,
+                              guint32 to);
+Adds a priority mapping to the “ingress_priority_map” or
+“egress_priority_map” properties of the setting. If from
+ is
+already in the given priority map, this function will overwrite the
+existing entry with the new to
+.
+If map
+ is NM_VLAN_INGRESS_MAP then from
+ is the incoming 802.1q VLAN
+Priority Code Point (PCP) value, and to
+ is the Linux SKB priority value.
+If map
+ is NM_VLAN_EGRESS_MAP then from
+ is the Linux SKB priority value and
+to
+ is the outgoing 802.1q VLAN Priority Code Point (PCP) value.
+
+Parameters
+
--+++
-
-
+
+
+
+
+
+
+
+
-
-
+
+
+
+
+
+
+
+
 





 
 
 setting : the NMSettingVlan
- setting the NMSettingVlan  
map the type of priority map  
 
 Returns : the "flags" property of the setting from the priority to map to to
+  
to the priority to map from
+to  
 
 
 
 
+
+Returns
+ TRUE if the new priority mapping was successfully added to the
+list, FALSE if error
+
+
+

nm_setting_vlan_get_num_priorities ()

gint32              nm_setting_vlan_get_num_priorities  (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);

-Returns the number of entires in the -"ingress_priority_map" or "egress_priority_map" -properties of this setting. -

nm_setting_vlan_remove_priority ()

void
+nm_setting_vlan_remove_priority (NMSettingVlan *setting,
+                                 NMVlanPriorityMap map,
+                                 guint32 idx);

Removes the priority map at index idx + from the +“ingress_priority_map” or “egress_priority_map” +properties.

Parameters

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

`setting` :	the NMSettingVlan -	setting	the NMSettingVlan
`map` :	the type of priority map	map	the type of priority map
Returns :	return the number of ingress/egress priority entries, -1 if error	idx	the zero-based index of the priority map to remove

nm_setting_vlan_get_priority ()

gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 idx,
-                                                         guint32 *out_from,
-                                                         guint32 *out_to);

-Retrieve one of the entries of the "ingress_priority_map" -or "egress_priority_map" properties of this setting. -

nm_setting_vlan_remove_priority_by_value ()

gboolean
+nm_setting_vlan_remove_priority_by_value
+                               (NMSettingVlan *setting,
+                                NMVlanPriorityMap map,
+                                guint32 from,
+                                guint32 to);

Removes the priority map form +:to + from the “ingress_priority_map” +or “egress_priority_map” (according to map + argument) +properties.

Parameters

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

`setting` :	the NMSettingVlan -
`map` :	the type of priority map	setting	the NMSettingVlan
`idx` :	the zero-based index of the ingress/egress priority map entry
`out_from` :	on return the value of the priority map's 'from' item. [out] -	map	the type of priority map
`out_to` :	on return the value of priority map's 'to' item. [out] -	from	the priority to map to `to` +
Returns :	-`TRUE` if a priority map was returned, `FALSE` if error	to	the priority to map `from` +to

Returns

TRUE if the priority mapping was found and removed; FALSE if it was not.

Since 0.9.10

nm_setting_vlan_add_priority ()

gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);

-Adds a priority mapping to the "ingress_priority_map" or -"egress_priority_map" properties of the setting. If from is -already in the given priority map, this function will overwrite the -existing entry with the new to. -

-If map is NM_VLAN_INGRESS_MAP then from is the incoming 802.1q VLAN -Priority Code Point (PCP) value, and to is the Linux SKB priority value. -

-If map is NM_VLAN_EGRESS_MAP then from is the Linux SKB priority value and -to is the outgoing 802.1q VLAN Priority Code Point (PCP) value. -

nm_setting_vlan_remove_priority_str_by_value ()

gboolean
+nm_setting_vlan_remove_priority_str_by_value
+                               (NMSettingVlan *setting,
+                                NMVlanPriorityMap map,
+                                const char *str);

Removes the priority map str + from the “ingress_priority_map” +or “egress_priority_map” (according to map + argument) +properties.

Parameters

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

`setting` :	the NMSettingVlan -
`map` :	the type of priority map
`from` :	the priority to map to `to` -	setting	the NMSettingVlan
`to` :	the priority to map `from` to	map	the type of priority map
Returns :	-`TRUE` if the new priority mapping was successfully added to the -list, `FALSE` if error	str	the string which contains a priority map, like "3:7"

Returns

TRUE if the priority mapping was found and removed; FALSE if it was not.

Since 0.9.10

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

`NM_VLAN_INGRESS_MAP`	map for incoming data -
`NM_VLAN_EGRESS_MAP`	map for outgoing data -
setting	the NMSettingVlan

`NM_VLAN_FLAG_REORDER_HEADERS`	indicates that this interface should reorder - outgoing packet headers to look more like a non-VLAN Ethernet interface -
`NM_VLAN_FLAG_GVRP`	indicates that this interface should use GVRP to register - itself with it's switch -
`NM_VLAN_FLAG_LOOSE_BINDING`	indicates that this interface's operating - state is tied to the underlying network interface but other details - (like routing) are not. -
setting	the NMSettingVlan

`setting` :	the NMSettingVlan +	NM_SETTING_VLAN_ERROR_UNKNOWN	+ unknown or unclassified error
`map` :	the type of priority map	NM_SETTING_VLAN_ERROR_INVALID_PROPERTY	+ the property was invalid +
`str` :	the string which contains a priority map, like "3:7"	NM_SETTING_VLAN_ERROR_MISSING_PROPERTY	+ the property was missing and is + required +
Returns :	-`TRUE` if the priority mapping was found and removed; `FALSE` if it was not.	NM_SETTING_VLAN_ERROR_INVALID_PARENT	+ the VLAN parent was specified + inconsistently +

`setting` :	the NMSettingVlan +	NM_VLAN_INGRESS_MAP	+ map for incoming data
`map` :	the type of priority map	NM_VLAN_EGRESS_MAP	+ map for outgoing data +

`setting` :	the NMSettingVlan +	NM_VLAN_FLAG_REORDER_HEADERS	+ indicates that this interface should reorder + outgoing packet headers to look more like a non-VLAN Ethernet interface
`map` :	the type of priority map
`str` :	the string which contains a priority map, like "3:7"	NM_VLAN_FLAG_GVRP	+ indicates that this interface should use GVRP to register + itself with it's switch +
Returns :	-`TRUE` if the entry was successfully added to the list, or it -overwrote the old value, `FALSE` if error	NM_VLAN_FLAG_LOOSE_BINDING	+ indicates that this interface's operating + state is tied to the underlying network interface but other details + (like routing) are not. +

NMSettingVlan

Synopsis

Object Hierarchy

Properties

Description

Details

NM_SETTING_VLAN_SETTING_NAME

enum NMSettingVlanError

Functions

NM_SETTING_VLAN_ERROR

Properties

nm_setting_vlan_error_quark ()

Types and Values

NM_SETTING_VLAN_INTERFACE_NAME

Object Hierarchy

NM_SETTING_VLAN_PARENT

Includes

NM_SETTING_VLAN_ID

Description

Functions

NM_SETTING_VLAN_FLAGS

nm_setting_vlan_error_quark ()

Returns

NM_SETTING_VLAN_INGRESS_PRIORITY_MAP

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

nm_setting_vlan_new ()

Returns

NMSettingVlan

NMSettingVlanClass

nm_setting_vlan_get_interface_name ()

Parameters

Returns

enum NMVlanPriorityMap

nm_setting_vlan_get_parent ()

Parameters

Returns

enum NMVlanFlags

nm_setting_vlan_get_id ()

Parameters

Returns

nm_setting_vlan_new ()

nm_setting_vlan_get_flags ()

Parameters

Returns

nm_setting_vlan_get_interface_name ()

nm_setting_vlan_get_num_priorities ()

Parameters

Returns

nm_setting_vlan_get_parent ()

nm_setting_vlan_get_priority ()

Parameters

nm_setting_vlan_get_id ()

Returns

nm_setting_vlan_get_flags ()

nm_setting_vlan_add_priority ()

Parameters

Returns

nm_setting_vlan_get_num_priorities ()

nm_setting_vlan_remove_priority ()

Parameters

nm_setting_vlan_get_priority ()

nm_setting_vlan_remove_priority_by_value ()

Parameters

Returns

nm_setting_vlan_add_priority ()

nm_setting_vlan_remove_priority_str_by_value ()

Parameters

Returns

nm_setting_vlan_remove_priority ()

nm_setting_vlan_clear_priorities ()

Parameters

nm_setting_vlan_remove_priority_by_value ()

nm_setting_vlan_add_priority_str ()

Parameters

Returns

Types and Values

nm_setting_vlan_remove_priority_str_by_value ()

NM_SETTING_VLAN_SETTING_NAME

enum NMSettingVlanError

Members

The `"egress-priority-map"` property

The `“egress-priority-map”` property

The `"flags"` property

The `“flags”` property

The `"id"` property

The `“id”` property

The `"ingress-priority-map"` property

The `“ingress-priority-map”` property

The `"interface-name"` property

The `“interface-name”` property

The `"parent"` property

The `“parent”` property