From a4256940da049f91bbbea5e53e469a59ea9c10f7 Mon Sep 17 00:00:00 2001 From: Sjoerd Simons Date: Fri, 25 Oct 2013 21:20:58 +0200 Subject: Imported Upstream version 0.9.8.8 --- docs/libnm-util/html/NMSettingVlan.html | 515 +++++++++++++++++--------------- 1 file changed, 280 insertions(+), 235 deletions(-) (limited to 'docs/libnm-util/html/NMSettingVlan.html') diff --git a/docs/libnm-util/html/NMSettingVlan.html b/docs/libnm-util/html/NMSettingVlan.html index b1edb3ad..edc209ba 100644 --- a/docs/libnm-util/html/NMSettingVlan.html +++ b/docs/libnm-util/html/NMSettingVlan.html @@ -3,12 +3,12 @@ NMSettingVlan - + - + @@ -41,51 +41,55 @@

Synopsis

-
+
 #include <nm-setting-vlan.h>
 
-                    NMSettingVlan;
-                    NMSettingVlanClass;
+#define             NM_SETTING_VLAN_SETTING_NAME
 enum                NMSettingVlanError;
-enum                NMVlanFlags;
-enum                NMVlanPriorityMap;
-#define             NM_SETTING_VLAN_EGRESS_PRIORITY_MAP
 #define             NM_SETTING_VLAN_ERROR
-#define             NM_SETTING_VLAN_FLAGS
-#define             NM_SETTING_VLAN_ID
-#define             NM_SETTING_VLAN_INGRESS_PRIORITY_MAP
+GQuark              nm_setting_vlan_error_quark         (void);
 #define             NM_SETTING_VLAN_INTERFACE_NAME
 #define             NM_SETTING_VLAN_PARENT
-#define             NM_SETTING_VLAN_SETTING_NAME
-gboolean            nm_setting_vlan_add_priority        (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         guint32 from,
-                                                         guint32 to);
-gboolean            nm_setting_vlan_add_priority_str    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map,
-                                                         const char *str);
-void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
-GQuark              nm_setting_vlan_error_quark         (void);
-guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
+#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);
-const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
 gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map,
                                                          guint32 idx,
                                                          guint32 *out_from,
                                                          guint32 *out_to);
-NMSetting *         nm_setting_vlan_new                 (void);
+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);
+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
@@ -93,16 +97,12 @@ const char *        
   GEnum
-   +----NMSettingVlanError
+   +----NMVlanPriorityMap
 
   GEnum
    +----NMVlanFlags
 
-
-  GEnum
-   +----NMVlanPriorityMap
-

Properties

@@ -125,23 +125,8 @@ necessary for connection to VLAN interfaces.

Details

-

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_SETTING_NAME

+
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
 

@@ -156,8 +141,11 @@ necessary for connection to VLAN interfaces. NM_SETTING_VLAN_ERROR_INVALID_PARENT /*< nick=InvalidParent >*/ } NMSettingVlanError;
-
+
+++ @@ -186,99 +174,58 @@ necessary for connection to VLAN interfaces.
-

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

NM_SETTING_VLAN_ERROR

+
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
 

-NMVlanFlags values control the behavior of the VLAN interface.

-

NM_SETTING_VLAN_ERROR_UNKNOWN

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

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

-

enum NMVlanPriorityMap

-
typedef enum {
-	NM_VLAN_INGRESS_MAP,
-	NM_VLAN_EGRESS_MAP
-} NMVlanPriorityMap;
-
+

nm_setting_vlan_error_quark ()

+
GQuark              nm_setting_vlan_error_quark         (void);

-A selector for traffic priority maps; these map Linux SKB priorities -to 802.1p priorities used in VLANs. +Registers an error quark for NMSettingVlan if necessary.

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

NM_VLAN_INGRESS_MAP

map for incoming data -

NM_VLAN_EGRESS_MAP

map for outgoing data -

Returns :

the error quark used for NMSettingVlan errors.

-

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

-
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
+

NM_SETTING_VLAN_INTERFACE_NAME

+
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
 


-

NM_SETTING_VLAN_ERROR

-
#define NM_SETTING_VLAN_ERROR nm_setting_vlan_error_quark ()
+

NM_SETTING_VLAN_PARENT

+
#define NM_SETTING_VLAN_PARENT               "parent"
 


-

NM_SETTING_VLAN_FLAGS

-
#define NM_SETTING_VLAN_FLAGS                "flags"
+

NM_SETTING_VLAN_ID

+
#define NM_SETTING_VLAN_ID                   "id"
 


-

NM_SETTING_VLAN_ID

-
#define NM_SETTING_VLAN_ID                   "id"
+

NM_SETTING_VLAN_FLAGS

+
#define NM_SETTING_VLAN_FLAGS                "flags"
 

@@ -293,124 +240,136 @@ to 802.1p priorities used in VLANs.

-

NM_SETTING_VLAN_INTERFACE_NAME

-
#define NM_SETTING_VLAN_INTERFACE_NAME       "interface-name"
+

NM_SETTING_VLAN_EGRESS_PRIORITY_MAP

+
#define NM_SETTING_VLAN_EGRESS_PRIORITY_MAP  "egress-priority-map"
 


-

NM_SETTING_VLAN_PARENT

-
#define NM_SETTING_VLAN_PARENT               "parent"
-
+

NMSettingVlan

+
typedef struct _NMSettingVlan NMSettingVlan;


-

NM_SETTING_VLAN_SETTING_NAME

-
#define NM_SETTING_VLAN_SETTING_NAME "vlan"
+

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

+

enum NMVlanPriorityMap

+
typedef enum {
+	NM_VLAN_INGRESS_MAP,
+	NM_VLAN_EGRESS_MAP
+} NMVlanPriorityMap;
+

-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. +A selector for traffic priority maps; these map Linux SKB priorities +to 802.1p priorities used in VLANs.

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

setting :

the NMSettingVlan +

NM_VLAN_INGRESS_MAP

map for incoming data

map :

the type of priority map

from :

the priority to map to to +

NM_VLAN_EGRESS_MAP

map for outgoing data

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

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

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

-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. +NMVlanFlags values control the behavior of the VLAN interface.

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

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

-

nm_setting_vlan_clear_priorities ()

-
void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
-                                                         NMVlanPriorityMap map);
+

nm_setting_vlan_new ()

+
NMSetting *         nm_setting_vlan_new                 (void);

-Clear all the entires from "ingress_priority_map" or -"egress_priority_map" properties. +Creates a new NMSettingVlan object with default values.

-
+
++++ + + + + +

Returns :

the new empty NMSettingVlan object. [transfer full] +
+
+
+
+

nm_setting_vlan_get_interface_name ()

+
const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
+
+++ @@ -418,33 +377,21 @@ Clear all the entires from map :

-
+ +

setting :

the type of priority map

Returns :

the "interface_name" property of the setting

-

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

-
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
-
+

nm_setting_vlan_get_parent ()

+
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
+
+++ @@ -453,7 +400,7 @@ Registers an error quark for Returns :

-
+

setting :

the "flags" property of the settingthe "parent" property of the setting
@@ -462,8 +409,11 @@ Registers an error quark for

nm_setting_vlan_get_id ()

guint32             nm_setting_vlan_get_id              (NMSettingVlan *setting);
-
+
+++ @@ -479,10 +429,13 @@ Registers an error quark for -

nm_setting_vlan_get_interface_name ()

-
const char *        nm_setting_vlan_get_interface_name  (NMSettingVlan *setting);
-

setting :

+

nm_setting_vlan_get_flags ()

+
guint32             nm_setting_vlan_get_flags           (NMSettingVlan *setting);
+
+++ @@ -491,7 +444,7 @@ Registers an error quark for Returns :

-
+

setting :

the "interface_name" property of the settingthe "flags" property of the setting
@@ -506,8 +459,11 @@ Returns the number of entires in the "ingress_priority_map" or "egress_priority_map" properties of this setting.

-
+
+++ @@ -527,25 +483,6 @@ properties of this setting.
-

nm_setting_vlan_get_parent ()

-
const char *        nm_setting_vlan_get_parent          (NMSettingVlan *setting);
-

setting :

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

setting :

the NMSettingVlan -

Returns :

the "parent" property of the setting
-
-
-

nm_setting_vlan_get_priority ()

gboolean            nm_setting_vlan_get_priority        (NMSettingVlan *setting,
                                                          NMVlanPriorityMap map,
@@ -556,8 +493,11 @@ properties of this setting.
 Retrieve one of the entries of the "ingress_priority_map"
 or "egress_priority_map" properties of this setting.
 

-
+
+++ @@ -592,18 +532,55 @@ or
-

nm_setting_vlan_new ()

-
NMSetting *         nm_setting_vlan_new                 (void);
+

nm_setting_vlan_add_priority ()

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

-Creates a new NMSettingVlan object with default values. +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.

-

setting :

+

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

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

Returns :

the new empty NMSettingVlan object. [transfer full] +

setting :

the NMSettingVlan

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

@@ -617,8 +594,11 @@ Removes the priority map at index idx fr "ingress_priority_map" or "egress_priority_map" properties.

-
+
+++ @@ -636,6 +616,71 @@ properties.

setting :

+
+
+

nm_setting_vlan_clear_priorities ()

+
void                nm_setting_vlan_clear_priorities    (NMSettingVlan *setting,
+                                                         NMVlanPriorityMap map);
+

+Clear all the entires from "ingress_priority_map" or +"egress_priority_map" properties. +

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

setting :

the NMSettingVlan +

map :

the type of priority map
+
+
+
+

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

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

setting :

the NMSettingVlan +

map :

the type of priority map

str :

the string which contains a priority map, like "3:7"

Returns :

TRUE if the entry was successfully added to the list, or it +overwrote the old value, FALSE if error
+

Property Details

@@ -708,6 +753,6 @@ hardware-specific setting, like
- Generated by GTK-Doc V1.18
+ Generated by GTK-Doc V1.19 \ No newline at end of file -- cgit 1.3.0-6-gf8a5