NMSettingVlan

@@ -37,691 +31,841 @@

NMSettingVlan

NMSettingVlan — Describes connection properties for VLAN interfaces

- +

Synopsis

#define             NM_SETTING_VLAN_SETTING_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
-struct              NMSettingVlan;
-                    NMSettingVlanClass;
-enum                NMVlanPriorityMap;
-enum                NMVlanFlags;
-NMSetting *         nm_setting_vlan_new                 (void);
-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

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

-  GEnum
-   +----NMVlanPriorityMap
-

-  GFlags
-   +----NMVlanFlags
-

Functions

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

+NMSetting * +	+nm_setting_vlan_new () +
const char * +	+nm_setting_vlan_get_parent () +
+guint32 +	+nm_setting_vlan_get_id () +
+guint32 +	+nm_setting_vlan_get_flags () +
+gint32 +	+nm_setting_vlan_get_num_priorities () +
+gboolean +	+nm_setting_vlan_get_priority () +
+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 () +

Properties

-  "egress-priority-map"      GStrv                 : Read / Write
-  "flags"                    NMVlanFlags           : Read / Write / Construct
-  "id"                       guint                 : Read / Write / Construct
-  "ingress-priority-map"     GStrv                 : Read / Write
-  "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"
-

NM_SETTING_VLAN_PARENT

#define NM_SETTING_VLAN_PARENT               "parent"
-

NM_SETTING_VLAN_ID

#define NM_SETTING_VLAN_ID                   "id"
-

NM_SETTING_VLAN_FLAGS

#define NM_SETTING_VLAN_FLAGS                "flags"
-

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"
-

struct NMSettingVlan

struct NMSettingVlan;

NMSettingVlanClass

typedef struct {
-	NMSettingClass parent;
-} NMSettingVlanClass;
-

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_VLAN_INGRESS_MAP`	map for incoming data -	GStrv	egress-priority-map	Read / Write
`NM_VLAN_EGRESS_MAP`	map for outgoing data -	NMVlanFlags	flags	Read / Write / Construct
guint	id	Read / Write / Construct
GStrv	ingress-priority-map	Read / Write
+gchar *	parent	Read / Write / Construct

enum NMVlanFlags

typedef enum {
- /*< flags >*/
-	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. -

Types and Values

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

`NM_VLAN_FLAG_REORDER_HEADERS`	indicates that this interface should reorder - outgoing packet headers to look more like a non-VLAN Ethernet interface -	#define	NM_SETTING_VLAN_SETTING_NAME
`NM_VLAN_FLAG_GVRP`	indicates that this interface should use GVRP to register - itself with it's switch -	#define	NM_SETTING_VLAN_PARENT
`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. -	#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

Object Hierarchy

    GEnum
+    ╰── NMVlanPriorityMap
+    GFlags
+    ╰── NMVlanFlags
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingVlan
+

Description

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

Functions

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]

nm_setting_vlan_new ()

NMSetting *         nm_setting_vlan_new                 (void);

-Creates a new NMSettingVlan object with default values. -

nm_setting_vlan_get_parent ()

const char *
+nm_setting_vlan_get_parent (NMSettingVlan *setting);

Parameters

--+++ - - + + +

Returns :

the new empty NMSettingVlan object. [transfer full] -

setting

the NMSettingVlan

Returns

the “parent” property of the setting

nm_setting_vlan_get_parent ()

const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);

nm_setting_vlan_get_id ()

guint32
+nm_setting_vlan_get_id (NMSettingVlan *setting);

Parameters

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

`setting` :	the NMSettingVlan -
Returns :	the "parent" property of the setting
setting	the NMSettingVlan

Returns

the “id” property of the setting

nm_setting_vlan_get_id ()

guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);

nm_setting_vlan_get_flags ()

guint32
+nm_setting_vlan_get_flags (NMSettingVlan *setting);

Parameters

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

`setting` :	the NMSettingVlan -
Returns :	the "id" property of the setting
setting	the NMSettingVlan

Returns

the “flags” property of the 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. -

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	map	the type of priority map
`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] -
`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

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

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
`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	idx	the zero-based index of the priority map to remove

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

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 -	setting	the NMSettingVlan
map	the type of priority map
`map` :	the type of priority map	from	the priority to map to `to` +
`idx` :	the zero-based index of the priority map to remove	to	the priority to map `from` +to

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

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 -	setting	the NMSettingVlan
`map` :	the type of priority map	map	the type of priority map
`from` :	the priority to map to `to` -	str	the string which contains a priority map, like "3:7"

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

nm_setting_vlan_add_priority_str ()

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

Adds a priority map entry into either the “ingress_priority_map” +or the “egress_priority_map” properties. The priority map maps +the Linux SKB priorities to 802.1p priorities.

Parameters

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

`setting` :	the NMSettingVlan -	setting	the NMSettingVlan
`map` :	the type of priority map	map	the type of priority map
`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.	str	the string which contains a priority map, like "3:7"

Property Details

The `"egress-priority-map"` property

  "egress-priority-map"      GStrv                 : Read / Write

-For outgoing packets, a list of mappings from Linux SKB priorities to -802.1p priorities. The mapping is given in the format "from:to" where -both "from" and "to" are unsigned integers, ie "7:3". -

The `“egress-priority-map”` property

  “egress-priority-map”      GStrv

Flags: Read / Write

The `"flags"` property

  "flags"                    NMVlanFlags           : Read / Write / Construct

-One or more flags which control the behavior and features of the VLAN -interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (reordering of -output packet headers), NM_VLAN_FLAG_GVRP (use of the GVRP protocol), -and NM_VLAN_FLAG_LOOSE_BINDING (loose binding of the interface to its -master device's operating state). -

The `“flags”` property

  “flags”                    NMVlanFlags

Flags: Read / Write / Construct

The `"id"` property

  "id"                       guint                 : Read / Write / Construct

-The VLAN identifier that the interface created by this connection should -be assigned. -

The `“id”` property

  “id”                       guint

Flags: Read / Write / Construct

Allowed values: <= 4095

Default value: 0

The `"ingress-priority-map"` property

  "ingress-priority-map"     GStrv                 : Read / Write

-For incoming packets, a list of mappings from 802.1p priorities to Linux -SKB priorities. The mapping is given in the format "from:to" where both -"from" and "to" are unsigned integers, ie "7:3". -

The `“ingress-priority-map”` property

  “ingress-priority-map”     GStrv

Flags: Read / Write

The `"parent"` property

  "parent"                   gchar*                : Read / Write / Construct

-If given, specifies the parent interface name or parent connection UUID -from which this VLAN interface should be created. If this property is -not specified, the connection must contain an NMSettingWired setting -with a "mac-address" property. -

The `“parent”` property

  “parent”                   gchar *

Flags: Read / Write / Construct

Default value: NULL

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

`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

Functions

Properties

Description

Details

NM_SETTING_VLAN_SETTING_NAME

NM_SETTING_VLAN_PARENT

NM_SETTING_VLAN_ID

NM_SETTING_VLAN_FLAGS

NM_SETTING_VLAN_INGRESS_PRIORITY_MAP

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

struct NMSettingVlan

NMSettingVlanClass

enum NMVlanPriorityMap

enum NMVlanFlags

Types and Values

Object Hierarchy

Description

Functions

nm_setting_vlan_new ()

Returns

nm_setting_vlan_new ()

nm_setting_vlan_get_parent ()

Parameters

Returns

nm_setting_vlan_get_parent ()

nm_setting_vlan_get_id ()

Parameters

Returns

nm_setting_vlan_get_id ()

nm_setting_vlan_get_flags ()

Parameters

Returns

nm_setting_vlan_get_flags ()

nm_setting_vlan_get_num_priorities ()

Parameters

Returns

nm_setting_vlan_get_num_priorities ()

nm_setting_vlan_get_priority ()

Parameters

Returns

nm_setting_vlan_get_priority ()

nm_setting_vlan_add_priority ()

Parameters

Returns

nm_setting_vlan_add_priority ()

nm_setting_vlan_remove_priority ()

Parameters

nm_setting_vlan_remove_priority ()

nm_setting_vlan_remove_priority_by_value ()

Parameters

Returns

nm_setting_vlan_remove_priority_by_value ()

nm_setting_vlan_remove_priority_str_by_value ()

Parameters

Returns

nm_setting_vlan_clear_priorities ()

Parameters

nm_setting_vlan_remove_priority_str_by_value ()

nm_setting_vlan_add_priority_str ()

Parameters

Returns

Types and Values

NM_SETTING_VLAN_SETTING_NAME

NM_SETTING_VLAN_PARENT

NM_SETTING_VLAN_ID

NM_SETTING_VLAN_FLAGS

nm_setting_vlan_clear_priorities ()

NM_SETTING_VLAN_INGRESS_PRIORITY_MAP

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

enum NMVlanPriorityMap

Members

nm_setting_vlan_add_priority_str ()

enum NMVlanFlags

Members

Property Details

The "egress-priority-map" property

The “egress-priority-map” property

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 `"parent"` property

The `“parent”` property