From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/NMSettingDcb.html | 1862 +++++++++++++++++++++---------------- 1 file changed, 1066 insertions(+), 796 deletions(-) (limited to 'docs/libnm/html/NMSettingDcb.html') diff --git a/docs/libnm/html/NMSettingDcb.html b/docs/libnm/html/NMSettingDcb.html index e9d9de64..ebfedd69 100644 --- a/docs/libnm/html/NMSettingDcb.html +++ b/docs/libnm/html/NMSettingDcb.html @@ -2,34 +2,28 @@ -NMSettingDcb +libnm Reference Manual: NMSettingDcb - + - - - - - - - - - - + + + + + + +
@@ -37,1104 +31,1380 @@

NMSettingDcb

NMSettingDcb — Connection properties for Data Center Bridging

- +
-
-

Synopsis

-
#define             NM_SETTING_DCB_SETTING_NAME
-enum                NMSettingDcbFlags;
-#define             NM_SETTING_DCB_FCOE_MODE_FABRIC
-#define             NM_SETTING_DCB_FCOE_MODE_VN2VN
-#define             NM_SETTING_DCB_APP_FCOE_FLAGS
-#define             NM_SETTING_DCB_APP_FCOE_PRIORITY
-#define             NM_SETTING_DCB_APP_FCOE_MODE
-#define             NM_SETTING_DCB_APP_ISCSI_FLAGS
-#define             NM_SETTING_DCB_APP_ISCSI_PRIORITY
-#define             NM_SETTING_DCB_APP_FIP_FLAGS
-#define             NM_SETTING_DCB_APP_FIP_PRIORITY
-#define             NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS
-#define             NM_SETTING_DCB_PRIORITY_FLOW_CONTROL
-#define             NM_SETTING_DCB_PRIORITY_GROUP_FLAGS
-#define             NM_SETTING_DCB_PRIORITY_GROUP_ID
-#define             NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH
-#define             NM_SETTING_DCB_PRIORITY_BANDWIDTH
-#define             NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH
-#define             NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS
-struct              NMSettingDcb;
-                    NMSettingDcbClass;
-NMSetting *         nm_setting_dcb_new                  (void);
-NMSettingDcbFlags   nm_setting_dcb_get_app_fcoe_flags   (NMSettingDcb *setting);
-gint                nm_setting_dcb_get_app_fcoe_priority
-                                                        (NMSettingDcb *setting);
-const char *        nm_setting_dcb_get_app_fcoe_mode    (NMSettingDcb *setting);
-NMSettingDcbFlags   nm_setting_dcb_get_app_iscsi_flags  (NMSettingDcb *setting);
-gint                nm_setting_dcb_get_app_iscsi_priority
-                                                        (NMSettingDcb *setting);
-NMSettingDcbFlags   nm_setting_dcb_get_app_fip_flags    (NMSettingDcb *setting);
-gint                nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting);
-NMSettingDcbFlags   nm_setting_dcb_get_priority_flow_control_flags
-                                                        (NMSettingDcb *setting);
-gboolean            nm_setting_dcb_get_priority_flow_control
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-void                nm_setting_dcb_set_priority_flow_control
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         gboolean enabled);
-NMSettingDcbFlags   nm_setting_dcb_get_priority_group_flags
-                                                        (NMSettingDcb *setting);
-guint               nm_setting_dcb_get_priority_group_id
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-void                nm_setting_dcb_set_priority_group_id
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint group_id);
-guint               nm_setting_dcb_get_priority_group_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint group_id);
-void                nm_setting_dcb_set_priority_group_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint group_id,
-                                                         guint bandwidth_percent);
-guint               nm_setting_dcb_get_priority_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-void                nm_setting_dcb_set_priority_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint bandwidth_percent);
-gboolean            nm_setting_dcb_get_priority_strict_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-void                nm_setting_dcb_set_priority_strict_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         gboolean strict);
-guint               nm_setting_dcb_get_priority_traffic_class
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-void                nm_setting_dcb_set_priority_traffic_class
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint traffic_class);
-
-
-
-

Object Hierarchy

-
-  GFlags
-   +----NMSettingDcbFlags
-
-
-  GObject
-   +----NMSetting
-         +----NMSettingDcb
-
-
-
-

Properties

-
-  "app-fcoe-flags"           NMSettingDcbFlags     : Read / Write
-  "app-fcoe-mode"            gchar*                : Read / Write / Construct
-  "app-fcoe-priority"        gint                  : Read / Write / Construct
-  "app-fip-flags"            NMSettingDcbFlags     : Read / Write
-  "app-fip-priority"         gint                  : Read / Write / Construct
-  "app-iscsi-flags"          NMSettingDcbFlags     : Read / Write
-  "app-iscsi-priority"       gint                  : Read / Write / Construct
-  "priority-bandwidth"       GArray*               : Read / Write
-  "priority-flow-control"    GArray*               : Read / Write
-  "priority-flow-control-flags" NMSettingDcbFlags     : Read / Write
-  "priority-group-bandwidth" GArray*               : Read / Write
-  "priority-group-flags"     NMSettingDcbFlags     : Read / Write
-  "priority-group-id"        GArray*               : Read / Write
-  "priority-strict-bandwidth" GArray*               : Read / Write
-  "priority-traffic-class"   GArray*               : Read / Write
-
-
-

Description

-

-The NMSettingDcb object is a NMSetting subclass that describes properties -for enabling and using Data Center Bridging (DCB) on Ethernet networks. -DCB is a set of protocols (including 802.1Qbb, 802.1Qaz, 802.1Qau, and -802.1AB) to eliminate packet loss in Ethernet networks and support the use -of storage technologies like Fibre Channel over Ethernet (FCoE) and iSCSI. -

-
-
-

Details

-
-

NM_SETTING_DCB_SETTING_NAME

-
#define NM_SETTING_DCB_SETTING_NAME "dcb"
-
-

-

-
-
-
-

enum NMSettingDcbFlags

-
typedef enum {
- /*< flags >*/
-	NM_SETTING_DCB_FLAG_NONE      = 0x00000000,
-	NM_SETTING_DCB_FLAG_ENABLE    = 0x00000001,
-	NM_SETTING_DCB_FLAG_ADVERTISE = 0x00000002,
-	NM_SETTING_DCB_FLAG_WILLING   = 0x00000004
-} NMSettingDcbFlags;
-
-

-DCB feature flags. -

-
+

Functions

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

NM_SETTING_DCB_FLAG_NONE

no flag + +NMSetting * + +nm_setting_dcb_new () +
+NMSettingDcbFlags + +nm_setting_dcb_get_app_fcoe_flags () +
+gint + +nm_setting_dcb_get_app_fcoe_priority () +
const char * + +nm_setting_dcb_get_app_fcoe_mode () +
+NMSettingDcbFlags + +nm_setting_dcb_get_app_iscsi_flags () +
+gint + +nm_setting_dcb_get_app_iscsi_priority () +
+NMSettingDcbFlags + +nm_setting_dcb_get_app_fip_flags () +
+gint + +nm_setting_dcb_get_app_fip_priority () +
+NMSettingDcbFlags + +nm_setting_dcb_get_priority_flow_control_flags () +
+gboolean + +nm_setting_dcb_get_priority_flow_control () +
+void + +nm_setting_dcb_set_priority_flow_control () +
+NMSettingDcbFlags + +nm_setting_dcb_get_priority_group_flags () +
+guint + +nm_setting_dcb_get_priority_group_id () +
+void + +nm_setting_dcb_set_priority_group_id () +
+guint + +nm_setting_dcb_get_priority_group_bandwidth () +
+void + +nm_setting_dcb_set_priority_group_bandwidth () +
+guint + +nm_setting_dcb_get_priority_bandwidth () +
+void + +nm_setting_dcb_set_priority_bandwidth () +
+gboolean + +nm_setting_dcb_get_priority_strict_bandwidth ()

NM_SETTING_DCB_FLAG_ENABLE

the feature is enabled + +void + +nm_setting_dcb_set_priority_strict_bandwidth ()

NM_SETTING_DCB_FLAG_ADVERTISE

the feature is advertised + +guint + +nm_setting_dcb_get_priority_traffic_class ()

NM_SETTING_DCB_FLAG_WILLING

the feature is willing to change based on -peer configuration advertisements + +void + +nm_setting_dcb_set_priority_traffic_class ()
-
-
-

NM_SETTING_DCB_FCOE_MODE_FABRIC

-
#define NM_SETTING_DCB_FCOE_MODE_FABRIC  "fabric"
-
-

-Indicates that the FCoE controller should use "fabric" mode (default) -

-
-
-
-

NM_SETTING_DCB_FCOE_MODE_VN2VN

-
#define NM_SETTING_DCB_FCOE_MODE_VN2VN   "vn2vn"
-
-

-Indicates that the FCoE controller should use "VN2VN" mode. -

-
-
-
-

NM_SETTING_DCB_APP_FCOE_FLAGS

-
#define NM_SETTING_DCB_APP_FCOE_FLAGS         "app-fcoe-flags"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_FCOE_PRIORITY

-
#define NM_SETTING_DCB_APP_FCOE_PRIORITY      "app-fcoe-priority"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_FCOE_MODE

-
#define NM_SETTING_DCB_APP_FCOE_MODE          "app-fcoe-mode"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_ISCSI_FLAGS

-
#define NM_SETTING_DCB_APP_ISCSI_FLAGS        "app-iscsi-flags"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_ISCSI_PRIORITY

-
#define NM_SETTING_DCB_APP_ISCSI_PRIORITY     "app-iscsi-priority"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_FIP_FLAGS

-
#define NM_SETTING_DCB_APP_FIP_FLAGS          "app-fip-flags"
-
-

-

-
-
-
-

NM_SETTING_DCB_APP_FIP_PRIORITY

-
#define NM_SETTING_DCB_APP_FIP_PRIORITY       "app-fip-priority"
-
-

-

-
-
-
-

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS

-
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS  "priority-flow-control-flags"
-
-

-

-
-
-
-

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL

-
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL        "priority-flow-control"
-
-

-

-
-
-
-

NM_SETTING_DCB_PRIORITY_GROUP_FLAGS

-
#define NM_SETTING_DCB_PRIORITY_GROUP_FLAGS      "priority-group-flags"
-
-

-

-
-
-
-

NM_SETTING_DCB_PRIORITY_GROUP_ID

-
#define NM_SETTING_DCB_PRIORITY_GROUP_ID         "priority-group-id"
-
-

-

-
-
-
-

NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH

-
#define NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH  "priority-group-bandwidth"
-
-

-

+
+

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NMSettingDcbFlagsapp-fcoe-flagsRead / Write
+gchar *app-fcoe-modeRead / Write / Construct
gintapp-fcoe-priorityRead / Write / Construct
NMSettingDcbFlagsapp-fip-flagsRead / Write
gintapp-fip-priorityRead / Write / Construct
NMSettingDcbFlagsapp-iscsi-flagsRead / Write
gintapp-iscsi-priorityRead / Write / Construct
+GArray *priority-bandwidthRead / Write
+GArray *priority-flow-controlRead / Write
NMSettingDcbFlagspriority-flow-control-flagsRead / Write
+GArray *priority-group-bandwidthRead / Write
NMSettingDcbFlagspriority-group-flagsRead / Write
+GArray *priority-group-idRead / Write
+GArray *priority-strict-bandwidthRead / Write
+GArray *priority-traffic-classRead / Write
-
-
-

NM_SETTING_DCB_PRIORITY_BANDWIDTH

-
#define NM_SETTING_DCB_PRIORITY_BANDWIDTH        "priority-bandwidth"
-
-

-

+
+

Types and Values

+
++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
#defineNM_SETTING_DCB_SETTING_NAME
enumNMSettingDcbFlags
#defineNM_SETTING_DCB_FCOE_MODE_FABRIC
#defineNM_SETTING_DCB_FCOE_MODE_VN2VN
#defineNM_SETTING_DCB_APP_FCOE_FLAGS
#defineNM_SETTING_DCB_APP_FCOE_PRIORITY
#defineNM_SETTING_DCB_APP_FCOE_MODE
#defineNM_SETTING_DCB_APP_ISCSI_FLAGS
#defineNM_SETTING_DCB_APP_ISCSI_PRIORITY
#defineNM_SETTING_DCB_APP_FIP_FLAGS
#defineNM_SETTING_DCB_APP_FIP_PRIORITY
#defineNM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS
#defineNM_SETTING_DCB_PRIORITY_FLOW_CONTROL
#defineNM_SETTING_DCB_PRIORITY_GROUP_FLAGS
#defineNM_SETTING_DCB_PRIORITY_GROUP_ID
#defineNM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH
#defineNM_SETTING_DCB_PRIORITY_BANDWIDTH
#defineNM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH
#defineNM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS
-
-
-

NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH

-
#define NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH "priority-strict-bandwidth"
+

+
Object Hierarchy

+
    GFlags
+    ╰── NMSettingDcbFlags
+    GObject
+    ╰── NMSetting
+        ╰── NMSettingDcb
 

-

-

 

-

-

-
NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS

-
#define NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS    "priority-traffic-class"
-

-

-

+

+
Description

+
The NMSettingDcb object is a NMSetting subclass that describes properties
+for enabling and using Data Center Bridging (DCB) on Ethernet networks.
+DCB is a set of protocols (including 802.1Qbb, 802.1Qaz, 802.1Qau, and
+802.1AB) to eliminate packet loss in Ethernet networks and support the use
+of storage technologies like Fibre Channel over Ethernet (FCoE) and iSCSI.

 

-

+

+
Functions

 

-
struct NMSettingDcb

-
struct NMSettingDcb;

-

-

+
nm_setting_dcb_new ()

+
NMSetting *
+nm_setting_dcb_new (void);

+
Creates a new NMSettingDcb object with default values.

+

+
Returns

+
 the new empty NMSettingDcb object. 

+
[transfer full]

 

-

-

-
NMSettingDcbClass

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

-

-

 

 

 

-
nm_setting_dcb_new ()

-
NMSetting *         nm_setting_dcb_new                  (void);

-

-Creates a new NMSettingDcb object with default values.
-

-

+
nm_setting_dcb_get_app_fcoe_flags ()

+
NMSettingDcbFlags
+nm_setting_dcb_get_app_fcoe_flags (NMSettingDcb *setting);

+

+
Parameters

+
--+++
-
-
+
+
+

 





 
 
Returns :
the new empty NMSettingDcb object. [transfer full]
-
setting
the NMSettingDcb
 
 

 

 

+

+
Returns

+
 the “app-fcoe-flags” property of the setting

+

+

+

 

 

-
nm_setting_dcb_get_app_fcoe_flags ()

-
NMSettingDcbFlags   nm_setting_dcb_get_app_fcoe_flags   (NMSettingDcb *setting);

-

+
nm_setting_dcb_get_app_fcoe_priority ()

+
gint
+nm_setting_dcb_get_app_fcoe_priority (NMSettingDcb *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingDcb
-
Returns :
the "app-fcoe-flags" property of the setting
setting
the NMSettingDcb
 

 

 

+

+
Returns

+
 the “app-fcoe-priority” property of the setting

+

+

+

 

 

-
nm_setting_dcb_get_app_fcoe_priority ()

-
gint                nm_setting_dcb_get_app_fcoe_priority
-                                                        (NMSettingDcb *setting);

-

+
nm_setting_dcb_get_app_fcoe_mode ()

+
const char *
+nm_setting_dcb_get_app_fcoe_mode (NMSettingDcb *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingDcb
-
Returns :
the "app-fcoe-priority" property of the setting
setting
the NMSettingDcb
 

 

 

+

+
Returns

+
 the “app-fcoe-mode” property of the setting

+

+

+

 

 

-
nm_setting_dcb_get_app_fcoe_mode ()

-
const char *        nm_setting_dcb_get_app_fcoe_mode    (NMSettingDcb *setting);

-

+
nm_setting_dcb_get_app_iscsi_flags ()

+
NMSettingDcbFlags
+nm_setting_dcb_get_app_iscsi_flags (NMSettingDcb *setting);

+

+
Parameters

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

 





 
setting :
the NMSettingDcb
-
Returns :
the "app-fcoe-mode" property of the setting
setting
the NMSettingDcb
 

 

 

+

+
Returns

+
 the “app-iscsi-flags” property of the setting

+

+

+
-

nm_setting_dcb_get_app_iscsi_flags ()

-
NMSettingDcbFlags   nm_setting_dcb_get_app_iscsi_flags  (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_app_iscsi_priority ()

+
gint
+nm_setting_dcb_get_app_iscsi_priority (NMSettingDcb *setting);
+
+

Parameters

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

setting :

the NMSettingDcb -

Returns :

the "app-iscsi-flags" property of the setting

setting

the NMSettingDcb

 
+
+

Returns

+

the “app-iscsi-priority” property of the setting

+

+
+
-

nm_setting_dcb_get_app_iscsi_priority ()

-
gint                nm_setting_dcb_get_app_iscsi_priority
-                                                        (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_app_fip_flags ()

+
NMSettingDcbFlags
+nm_setting_dcb_get_app_fip_flags (NMSettingDcb *setting);
+
+

Parameters

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

setting :

the NMSettingDcb -

Returns :

the "app-iscsi-priority" property of the setting

setting

the NMSettingDcb

 
+
+

Returns

+

the “app-fip-flags” property of the setting

+

+
+
-

nm_setting_dcb_get_app_fip_flags ()

-
NMSettingDcbFlags   nm_setting_dcb_get_app_fip_flags    (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_app_fip_priority ()

+
gint
+nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting);
+
+

Parameters

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

setting :

the NMSettingDcb -

Returns :

the "app-fip-flags" property of the setting

setting

the NMSettingDcb

 
+
+

Returns

+

the “app-fip-priority” property of the setting

+

+
+
-

nm_setting_dcb_get_app_fip_priority ()

-
gint                nm_setting_dcb_get_app_fip_priority (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_priority_flow_control_flags ()

+
NMSettingDcbFlags
+nm_setting_dcb_get_priority_flow_control_flags
+                               (NMSettingDcb *setting);
+
+

Parameters

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

setting :

the NMSettingDcb -

Returns :

the "app-fip-priority" property of the setting

setting

the NMSettingDcb

 
+
+

Returns

+

the “priority-flow-control-flags” property of the setting

+

+
+
-

nm_setting_dcb_get_priority_flow_control_flags ()

-
NMSettingDcbFlags   nm_setting_dcb_get_priority_flow_control_flags
-                                                        (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_priority_flow_control ()

+
gboolean
+nm_setting_dcb_get_priority_flow_control
+                               (NMSettingDcb *setting,
+                                guint user_priority);
+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

Returns :

the "priority-flow-control-flags" property of the setting

user_priority

the User Priority (0 - 7) to retrieve flow control for

 
+
+

Returns

+

TRUE if flow control is enabled for the given user_priority +, +FALSE if not enabled

+

+
+
-

nm_setting_dcb_get_priority_flow_control ()

-
gboolean            nm_setting_dcb_get_priority_flow_control
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-
+

nm_setting_dcb_set_priority_flow_control ()

+
void
+nm_setting_dcb_set_priority_flow_control
+                               (NMSettingDcb *setting,
+                                guint user_priority,
+                                gboolean enabled);
+

These values are only valid when “priority-flow-control” includes +the NM_SETTING_DCB_FLAG_ENABLE flag.

+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

user_priority :

the User Priority (0 - 7) to retrieve flow control for

user_priority

the User Priority (0 - 7) to set flow control for

 

Returns :

 -TRUE if flow control is enabled for the given user_priority, -FALSE if not enabled

enabled

TRUE to enable flow control for this priority, FALSE to disable it

 
+
-

nm_setting_dcb_set_priority_flow_control ()

-
void                nm_setting_dcb_set_priority_flow_control
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         gboolean enabled);
-

-These values are only valid when "priority-flow-control" includes -the NM_SETTING_DCB_FLAG_ENABLE flag. -

-
+

nm_setting_dcb_get_priority_group_flags ()

+
NMSettingDcbFlags
+nm_setting_dcb_get_priority_group_flags
+                               (NMSettingDcb *setting);
+
+

Parameters

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

setting :

the NMSettingDcb -

user_priority :

the User Priority (0 - 7) to set flow control for

enabled :

 -TRUE to enable flow control for this priority, FALSE to disable it

setting

the NMSettingDcb

 
+
+

Returns

+

the “priority-group-flags” property of the setting

+

+
+
-

nm_setting_dcb_get_priority_group_flags ()

-
NMSettingDcbFlags   nm_setting_dcb_get_priority_group_flags
-                                                        (NMSettingDcb *setting);
-
+

nm_setting_dcb_get_priority_group_id ()

+
guint
+nm_setting_dcb_get_priority_group_id (NMSettingDcb *setting,
+                                      guint user_priority);
+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

Returns :

the "priority-group-flags" property of the setting

user_priority

the User Priority (0 - 7) to retrieve the group ID for

 
+
+

Returns

+

the group number user_priority +is assigned to. These values are +only valid when “priority-group-flags” includes the +NM_SETTING_DCB_FLAG_ENABLE flag.

+

+
+
-

nm_setting_dcb_get_priority_group_id ()

-
guint               nm_setting_dcb_get_priority_group_id
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-
+

nm_setting_dcb_set_priority_group_id ()

+
void
+nm_setting_dcb_set_priority_group_id (NMSettingDcb *setting,
+                                      guint user_priority,
+                                      guint group_id);
+

These values are only valid when “priority-group-flags” includes +the NM_SETTING_DCB_FLAG_ENABLE flag.

+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

user_priority :

the User Priority (0 - 7) to retrieve the group ID for

user_priority

the User Priority (0 - 7) to set flow control for

 

Returns :

the group number user_priority is assigned to. These values are -only valid when "priority-group-flags" includes the -NM_SETTING_DCB_FLAG_ENABLE flag.

group_id

the group (0 - 7) to assign user_priority +to, or 15 for the +unrestricted group.

 
+
-

nm_setting_dcb_set_priority_group_id ()

-
void                nm_setting_dcb_set_priority_group_id
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint group_id);
-

-These values are only valid when "priority-group-flags" includes -the NM_SETTING_DCB_FLAG_ENABLE flag. -

-
+

nm_setting_dcb_get_priority_group_bandwidth ()

+
guint
+nm_setting_dcb_get_priority_group_bandwidth
+                               (NMSettingDcb *setting,
+                                guint group_id);
+
+

Parameters

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

setting :

the NMSettingDcb -

user_priority :

the User Priority (0 - 7) to set flow control for

setting

the NMSettingDcb

 

group_id :

the group (0 - 7) to assign user_priority to, or 15 for the -unrestricted group.

group_id

the priority group (0 - 7) to retrieve the bandwidth percentage for

 
+
+

Returns

+

the bandwidth percentage assigned to group_id +. These values are +only valid when “priority-group-flags” includes the +NM_SETTING_DCB_FLAG_ENABLE flag.

+

+
+
-

nm_setting_dcb_get_priority_group_bandwidth ()

-
guint               nm_setting_dcb_get_priority_group_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint group_id);
-
+

nm_setting_dcb_set_priority_group_bandwidth ()

+
void
+nm_setting_dcb_set_priority_group_bandwidth
+                               (NMSettingDcb *setting,
+                                guint group_id,
+                                guint bandwidth_percent);
+

These values are only valid when “priority-group-flags” includes +the NM_SETTING_DCB_FLAG_ENABLE flag.

+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

group_id :

the priority group (0 - 7) to retrieve the bandwidth percentage for

group_id

the priority group (0 - 7) to set the bandwidth percentage for

 

Returns :

the bandwidth percentage assigned to group_id. These values are -only valid when "priority-group-flags" includes the -NM_SETTING_DCB_FLAG_ENABLE flag.

bandwidth_percent

the bandwidth percentage (0 - 100) to assign to group_id +to

 
+
-

nm_setting_dcb_set_priority_group_bandwidth ()

-
void                nm_setting_dcb_set_priority_group_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint group_id,
-                                                         guint bandwidth_percent);
-

-These values are only valid when "priority-group-flags" includes -the NM_SETTING_DCB_FLAG_ENABLE flag. -

-
+

nm_setting_dcb_get_priority_bandwidth ()

+
guint
+nm_setting_dcb_get_priority_bandwidth (NMSettingDcb *setting,
+                                       guint user_priority);
+
+

Parameters

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

setting :

the NMSettingDcb -

group_id :

the priority group (0 - 7) to set the bandwidth percentage for

setting

the NMSettingDcb

 

bandwidth_percent :

the bandwidth percentage (0 - 100) to assign to group_id to

user_priority

the User Priority (0 - 7) to retrieve the group bandwidth percentage for

 
+
+

Returns

+

the allowed bandwidth percentage of user_priority +in its priority group. +These values are only valid when “priority-group-flags” includes the +NM_SETTING_DCB_FLAG_ENABLE flag.

+

+
+
-

nm_setting_dcb_get_priority_bandwidth ()

-
guint               nm_setting_dcb_get_priority_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-
+

nm_setting_dcb_set_priority_bandwidth ()

+
void
+nm_setting_dcb_set_priority_bandwidth (NMSettingDcb *setting,
+                                       guint user_priority,
+                                       guint bandwidth_percent);
+

These values are only valid when “priority-group-flags” includes +the NM_SETTING_DCB_FLAG_ENABLE flag.

+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

user_priority :

the User Priority (0 - 7) to retrieve the group bandwidth percentage for

user_priority

the User Priority (0 - 7) to set the bandwidth percentage for

 

Returns :

the allowed bandwidth percentage of user_priority in its priority group. -These values are only valid when "priority-group-flags" includes the -NM_SETTING_DCB_FLAG_ENABLE flag.

bandwidth_percent

the bandwidth percentage (0 - 100) that user_priority +is +allowed to use within its priority group

 
+
-

nm_setting_dcb_set_priority_bandwidth ()

-
void                nm_setting_dcb_set_priority_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint bandwidth_percent);
-

-These values are only valid when "priority-group-flags" includes -the NM_SETTING_DCB_FLAG_ENABLE flag. -

-
+

nm_setting_dcb_get_priority_strict_bandwidth ()

+
gboolean
+nm_setting_dcb_get_priority_strict_bandwidth
+                               (NMSettingDcb *setting,
+                                guint user_priority);
+
+

Parameters

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

setting :

the NMSettingDcb -

user_priority :

the User Priority (0 - 7) to set the bandwidth percentage for

setting

the NMSettingDcb

 

bandwidth_percent :

the bandwidth percentage (0 - 100) that user_priority is -allowed to use within its priority group

user_priority

the User Priority (0 - 7) to retrieve strict bandwidth for

 
+
+

Returns

+

TRUE if user_priority +may use all of the bandwidth allocated to its +assigned group, or FALSE if not. These values are only valid when +“priority-group-flags” includes the NM_SETTING_DCB_FLAG_ENABLE flag.

+

+
+
-

nm_setting_dcb_get_priority_strict_bandwidth ()

-
gboolean            nm_setting_dcb_get_priority_strict_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-
+

nm_setting_dcb_set_priority_strict_bandwidth ()

+
void
+nm_setting_dcb_set_priority_strict_bandwidth
+                               (NMSettingDcb *setting,
+                                guint user_priority,
+                                gboolean strict);
+

These values are only valid when “priority-group-flags” includes +the NM_SETTING_DCB_FLAG_ENABLE flag.

+
+

Parameters

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

setting :

the NMSettingDcb -

setting

the NMSettingDcb

 

user_priority :

the User Priority (0 - 7) to retrieve strict bandwidth for

user_priority

the User Priority (0 - 7) to set strict bandwidth for

 

Returns :

 -TRUE if user_priority may use all of the bandwidth allocated to its -assigned group, or FALSE if not. These values are only valid when -"priority-group-flags" includes the NM_SETTING_DCB_FLAG_ENABLE flag.

strict

TRUE to allow user_priority +to use all the bandwidth allocated to +its priority group, or FALSE if not

 
+
-

nm_setting_dcb_set_priority_strict_bandwidth ()

-
void                nm_setting_dcb_set_priority_strict_bandwidth
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         gboolean strict);
-

-These values are only valid when "priority-group-flags" includes -the NM_SETTING_DCB_FLAG_ENABLE flag. -

-
+

nm_setting_dcb_get_priority_traffic_class ()

+
guint
+nm_setting_dcb_get_priority_traffic_class
+                               (NMSettingDcb *setting,
+                                guint user_priority);
+
+

Parameters

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

setting :

the NMSettingDcb -

user_priority :

the User Priority (0 - 7) to set strict bandwidth for

setting

the NMSettingDcb

 

strict :

 -TRUE to allow user_priority to use all the bandwidth allocated to -its priority group, or FALSE if not

user_priority

the User Priority (0 - 7) to retrieve the traffic class for

 
+
+

Returns

+

the traffic class assigned to user_priority +. These values are only +valid when “priority-group-flags” includes the +NM_SETTING_DCB_FLAG_ENABLE flag.

+

+
+ +
+
+

nm_setting_dcb_set_priority_traffic_class ()

+
void
+nm_setting_dcb_set_priority_traffic_class
+                               (NMSettingDcb *setting,
+                                guint user_priority,
+                                guint traffic_class);
+

+

+
+ +
+

Types and Values

+
+

NM_SETTING_DCB_SETTING_NAME

+
#define NM_SETTING_DCB_SETTING_NAME "dcb"
+
+

+

+
-

nm_setting_dcb_get_priority_traffic_class ()

-
guint               nm_setting_dcb_get_priority_traffic_class
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority);
-
+

enum NMSettingDcbFlags

+

DCB feature flags.

+
+

Members

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

setting :

the NMSettingDcb +

NM_SETTING_DCB_FLAG_NONE

 +

no flag

+		 

NM_SETTING_DCB_FLAG_ENABLE

 +

the feature is enabled

 

user_priority :

the User Priority (0 - 7) to retrieve the traffic class for

NM_SETTING_DCB_FLAG_ADVERTISE

 +

the feature is advertised

+		 

Returns :

the traffic class assigned to user_priority. These values are only -valid when "priority-group-flags" includes the -NM_SETTING_DCB_FLAG_ENABLE flag.

NM_SETTING_DCB_FLAG_WILLING

 +

the feature is willing to change based on +peer configuration advertisements

+		 
+
-

nm_setting_dcb_set_priority_traffic_class ()

-
void                nm_setting_dcb_set_priority_traffic_class
-                                                        (NMSettingDcb *setting,
-                                                         guint user_priority,
-                                                         guint traffic_class);
-

-

+

NM_SETTING_DCB_FCOE_MODE_FABRIC

+
#define NM_SETTING_DCB_FCOE_MODE_FABRIC  "fabric"
+
+

Indicates that the FCoE controller should use "fabric" mode (default)

+
+
+

NM_SETTING_DCB_FCOE_MODE_VN2VN

+
#define NM_SETTING_DCB_FCOE_MODE_VN2VN   "vn2vn"
+
+

Indicates that the FCoE controller should use "VN2VN" mode.

-
-

Property Details

+
-

The "app-fcoe-flags" property

-
  "app-fcoe-flags"           NMSettingDcbFlags     : Read / Write
+

NM_SETTING_DCB_APP_FCOE_FLAGS

+
#define NM_SETTING_DCB_APP_FCOE_FLAGS         "app-fcoe-flags"
+

-Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may -be any combination of NM_SETTING_DCB_FLAG_ENABLE, -NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING.

-

The "app-fcoe-mode" property

-
  "app-fcoe-mode"            gchar*                : Read / Write / Construct
+

NM_SETTING_DCB_APP_FCOE_PRIORITY

+
#define NM_SETTING_DCB_APP_FCOE_PRIORITY      "app-fcoe-priority"
+

-The FCoE controller mode; either NM_SETTING_DCB_FCOE_MODE_FABRIC -(default) or NM_SETTING_DCB_FCOE_MODE_VN2VN.

-

Default value: "fabric"

-

The "app-fcoe-priority" property

-
  "app-fcoe-priority"        gint                  : Read / Write / Construct
+

NM_SETTING_DCB_APP_FCOE_MODE

+
#define NM_SETTING_DCB_APP_FCOE_MODE          "app-fcoe-mode"
+

-The highest User Priority (0 - 7) which FCoE frames should use, or -1 for -default priority. Only used when the "app-fcoe-flags" -property includes the NM_SETTING_DCB_FLAG_ENABLE flag.

-

Allowed values: [-1,7]

-

Default value: -1

-

The "app-fip-flags" property

-
  "app-fip-flags"            NMSettingDcbFlags     : Read / Write
+

NM_SETTING_DCB_APP_ISCSI_FLAGS

+
#define NM_SETTING_DCB_APP_ISCSI_FLAGS        "app-iscsi-flags"
+

-Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may -be any combination of NM_SETTING_DCB_FLAG_ENABLE, -NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING.

-

The "app-fip-priority" property

-
  "app-fip-priority"         gint                  : Read / Write / Construct
+

NM_SETTING_DCB_APP_ISCSI_PRIORITY

+
#define NM_SETTING_DCB_APP_ISCSI_PRIORITY     "app-iscsi-priority"
+

-The highest User Priority (0 - 7) which FIP frames should use, or -1 for -default priority. Only used when the "app-fip-flags" -property includes the NM_SETTING_DCB_FLAG_ENABLE flag.

-

Allowed values: [-1,7]

-

Default value: -1

-

The "app-iscsi-flags" property

-
  "app-iscsi-flags"          NMSettingDcbFlags     : Read / Write
+

NM_SETTING_DCB_APP_FIP_FLAGS

+
#define NM_SETTING_DCB_APP_FIP_FLAGS          "app-fip-flags"
+

-Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags -may be any combination of NM_SETTING_DCB_FLAG_ENABLE, -NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING.

-

The "app-iscsi-priority" property

-
  "app-iscsi-priority"       gint                  : Read / Write / Construct
+

NM_SETTING_DCB_APP_FIP_PRIORITY

+
#define NM_SETTING_DCB_APP_FIP_PRIORITY       "app-fip-priority"
+

-The highest User Priority (0 - 7) which iSCSI frames should use, or -1 -for default priority. Only used when the "app-iscsi-flags" -property includes the NM_SETTING_DCB_FLAG_ENABLE flag.

-

Allowed values: [-1,7]

-

Default value: -1

-

The "priority-bandwidth" property

-
  "priority-bandwidth"       GArray*               : Read / Write
-

-An array of 8 uint values, where the array index corresponds to the User -Priority (0 - 7) and the value indicates the percentage of bandwidth of -the priority's assigned group that the priority may use. The sum of all -percentages for priorities which belong to the same group must total 100 -percent. -

+

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS

+
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL_FLAGS  "priority-flow-control-flags"
+

-Element-type: guint

-

The "priority-flow-control" property

-
  "priority-flow-control"    GArray*               : Read / Write
-

-An array of 8 boolean values, where the array index corresponds to the User -Priority (0 - 7) and the value indicates whether or not the corresponding -priority should transmit priority pause. -

+

NM_SETTING_DCB_PRIORITY_FLOW_CONTROL

+
#define NM_SETTING_DCB_PRIORITY_FLOW_CONTROL        "priority-flow-control"
+

-Element-type: gboolean

-

The "priority-flow-control-flags" property

-
  "priority-flow-control-flags" NMSettingDcbFlags     : Read / Write
+

NM_SETTING_DCB_PRIORITY_GROUP_FLAGS

+
#define NM_SETTING_DCB_PRIORITY_GROUP_FLAGS      "priority-group-flags"
+

-Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). -Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE, -NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING.

-

The "priority-group-bandwidth" property

-
  "priority-group-bandwidth" GArray*               : Read / Write
-

-An array of 8 uint values, where the array index corresponds to the -Priority Group ID (0 - 7) and the value indicates the percentage of link -bandwidth allocated to that group. Allowed values are 0 - 100, and the -sum of all values must total 100 percent. -

+

NM_SETTING_DCB_PRIORITY_GROUP_ID

+
#define NM_SETTING_DCB_PRIORITY_GROUP_ID         "priority-group-id"
+

-Element-type: guint

-

The "priority-group-flags" property

-
  "priority-group-flags"     NMSettingDcbFlags     : Read / Write
+

NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_GROUP_BANDWIDTH  "priority-group-bandwidth"
+

-Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be -any combination of NM_SETTING_DCB_FLAG_ENABLE, -NM_SETTING_DCB_FLAG_ADVERTISE, and NM_SETTING_DCB_FLAG_WILLING.

-

The "priority-group-id" property

-
  "priority-group-id"        GArray*               : Read / Write
-

-An array of 8 uint values, where the array index corresponds to the User -Priority (0 - 7) and the value indicates the Priority Group ID. Allowed -Priority Group ID values are 0 - 7 or 15 for the unrestricted group. -

+

NM_SETTING_DCB_PRIORITY_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_BANDWIDTH        "priority-bandwidth"
+

-Element-type: guint

-

The "priority-strict-bandwidth" property

-
  "priority-strict-bandwidth" GArray*               : Read / Write
-

-An array of 8 boolean values, where the array index corresponds to the User -Priority (0 - 7) and the value indicates whether or not the priority may -use all of the bandwidth allocated to its assigned group. -

+

NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH

+
#define NM_SETTING_DCB_PRIORITY_STRICT_BANDWIDTH "priority-strict-bandwidth"
+

-Element-type: gboolean

-

The "priority-traffic-class" property

-
  "priority-traffic-class"   GArray*               : Read / Write
-

-An array of 8 uint values, where the array index corresponds to the User -Priority (0 - 7) and the value indicates the traffic class (0 - 7) to -which the priority is mapped. -

+

NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS

+
#define NM_SETTING_DCB_PRIORITY_TRAFFIC_CLASS    "priority-traffic-class"
+

-Element-type: guint

+
+

Property Details

+
+

The “app-fcoe-flags” property

+
  “app-fcoe-flags”           NMSettingDcbFlags
+

+

Flags: Read / Write

+
+
+
+

The “app-fcoe-mode” property

+
  “app-fcoe-mode”            gchar *
+

+

Flags: Read / Write / Construct

+

Default value: "fabric"

+
+
+
+

The “app-fcoe-priority” property

+
  “app-fcoe-priority”        gint
+

+

Flags: Read / Write / Construct

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The “app-fip-flags” property

+
  “app-fip-flags”            NMSettingDcbFlags
+

+

Flags: Read / Write

+
+
+
+

The “app-fip-priority” property

+
  “app-fip-priority”         gint
+

+

Flags: Read / Write / Construct

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The “app-iscsi-flags” property

+
  “app-iscsi-flags”          NMSettingDcbFlags
+

+

Flags: Read / Write

+
+
+
+

The “app-iscsi-priority” property

+
  “app-iscsi-priority”       gint
+

+

Flags: Read / Write / Construct

+

Allowed values: [-1,7]

+

Default value: -1

+
+
+
+

The “priority-bandwidth” property

+
  “priority-bandwidth”       GArray *
+

+

Flags: Read / Write

+
+
+
+

The “priority-flow-control” property

+
  “priority-flow-control”    GArray *
+

+

Flags: Read / Write

+
+
+
+

The “priority-flow-control-flags” property

+
  “priority-flow-control-flags” NMSettingDcbFlags
+

+

Flags: Read / Write

+
+
+
+

The “priority-group-bandwidth” property

+
  “priority-group-bandwidth” GArray *
+

+

Flags: Read / Write

+
+
+
+

The “priority-group-flags” property

+
  “priority-group-flags”     NMSettingDcbFlags
+

+

Flags: Read / Write

+
+
+
+

The “priority-group-id” property

+
  “priority-group-id”        GArray *
+

+

Flags: Read / Write

+
+
+
+

The “priority-strict-bandwidth” property

+
  “priority-strict-bandwidth” GArray *
+

+

Flags: Read / Write

+
+
+
+

The “priority-traffic-class” property

+
  “priority-traffic-class”   GArray *
+

+

Flags: Read / Write

+
+
- Generated by GTK-Doc V1.19
+ Generated by GTK-Doc V1.21 \ No newline at end of file -- cgit 1.3.0-6-gf8a5