GI.NM.Objects.SettingDcb

Data Center Bridging Settings

Exported types

newtype SettingDcb

Memory-managed wrapper type.

Constructors

SettingDcb (ManagedPtr SettingDcb)

Instances

Eq SettingDcb

Defined in GI.NM.Objects.SettingDcb

Methods

(==) :: SettingDcb -> SettingDcb -> Bool

(/=) :: SettingDcb -> SettingDcb -> Bool

GObject SettingDcb

Defined in GI.NM.Objects.SettingDcb

ManagedPtrNewtype SettingDcb

Defined in GI.NM.Objects.SettingDcb

Methods

toManagedPtr :: SettingDcb -> ManagedPtr SettingDcb

TypedObject SettingDcb

Defined in GI.NM.Objects.SettingDcb

Methods

glibType :: IO GType

HasParentTypes SettingDcb

Defined in GI.NM.Objects.SettingDcb

IsGValue (Maybe SettingDcb)

Convert SettingDcb to and from GValue. See toGValue and fromGValue.

Defined in GI.NM.Objects.SettingDcb

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe SettingDcb -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe SettingDcb)

type ParentTypes SettingDcb

Defined in GI.NM.Objects.SettingDcb

type ParentTypes SettingDcb = '[Setting, Object]

class (GObject o, IsDescendantOf SettingDcb o) => IsSettingDcb o

Type class for types which can be safely cast to SettingDcb, for instance with toSettingDcb.

Instances

(GObject o, IsDescendantOf SettingDcb o) => IsSettingDcb o

Defined in GI.NM.Objects.SettingDcb

toSettingDcb :: (MonadIO m, IsSettingDcb o) => o -> m SettingDcb

Cast to SettingDcb, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

bindProperty, bindPropertyFull, compare, diff, duplicate, enumerateValues, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, optionClearByName, optionGet, optionGetAllNames, optionGetBoolean, optionGetUint32, optionSet, optionSetBoolean, optionSetUint32, ref, refSink, runDispose, stealData, stealQdata, thawNotify, toString, unref, verify, verifySecrets, watchClosure.

Getters

getAppFcoeFlags, getAppFcoeMode, getAppFcoePriority, getAppFipFlags, getAppFipPriority, getAppIscsiFlags, getAppIscsiPriority, getData, getDbusPropertyType, getName, getPriorityBandwidth, getPriorityFlowControl, getPriorityFlowControlFlags, getPriorityGroupBandwidth, getPriorityGroupFlags, getPriorityGroupId, getPriorityStrictBandwidth, getPriorityTrafficClass, getProperty, getQdata, getSecretFlags.

Setters

setData, setDataFull, setPriorityBandwidth, setPriorityFlowControl, setPriorityGroupBandwidth, setPriorityGroupId, setPriorityStrictBandwidth, setPriorityTrafficClass, setProperty, setSecretFlags.

getAppFcoeFlags

settingDcbGetAppFcoeFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m [SettingDcbFlags]

Returns: the SettingDcb:appFcoeFlags property of the setting

No description available in the introspection data.

getAppFcoeMode

settingDcbGetAppFcoeMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m Text

Returns: the SettingDcb:appFcoeMode property of the setting

No description available in the introspection data.

getAppFcoePriority

settingDcbGetAppFcoePriority

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m Int32

Returns: the SettingDcb:appFcoePriority property of the setting

No description available in the introspection data.

getAppFipFlags

settingDcbGetAppFipFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m [SettingDcbFlags]

Returns: the SettingDcb:appFipFlags property of the setting

No description available in the introspection data.

getAppFipPriority

settingDcbGetAppFipPriority

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m Int32

Returns: the SettingDcb:appFipPriority property of the setting

No description available in the introspection data.

getAppIscsiFlags

settingDcbGetAppIscsiFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m [SettingDcbFlags]

Returns: the SettingDcb:appIscsiFlags property of the setting

No description available in the introspection data.

getAppIscsiPriority

settingDcbGetAppIscsiPriority

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m Int32

Returns: the SettingDcb:appIscsiPriority property of the setting

No description available in the introspection data.

getPriorityBandwidth

settingDcbGetPriorityBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Word32

Returns: the allowed bandwidth percentage of userPriority in its priority group. These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

No description available in the introspection data.

getPriorityFlowControl

settingDcbGetPriorityFlowControl

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Bool

Returns: True if flow control is enabled for the given userPriority, False if not enabled

No description available in the introspection data.

getPriorityFlowControlFlags

settingDcbGetPriorityFlowControlFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m [SettingDcbFlags]

Returns: the SettingDcb:priorityFlowControlFlags property of the setting

No description available in the introspection data.

getPriorityGroupBandwidth

settingDcbGetPriorityGroupBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Word32

Returns: the bandwidth percentage assigned to groupId. These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

No description available in the introspection data.

getPriorityGroupFlags

settingDcbGetPriorityGroupFlags

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> m [SettingDcbFlags]

Returns: the SettingDcb:priorityGroupFlags property of the setting

No description available in the introspection data.

getPriorityGroupId

settingDcbGetPriorityGroupId

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Word32

Returns: the group number userPriority is assigned to. These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

No description available in the introspection data.

getPriorityStrictBandwidth

settingDcbGetPriorityStrictBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Bool

Returns: True if userPriority may use all of the bandwidth allocated to its assigned group, or False if not. These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

No description available in the introspection data.

getPriorityTrafficClass

settingDcbGetPriorityTrafficClass

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> m Word32

Returns: the traffic class assigned to userPriority. These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

No description available in the introspection data.

new

settingDcbNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingDcb

Returns: the new empty SettingDcb object

Creates a new SettingDcb object with default values.

setPriorityBandwidth

settingDcbSetPriorityBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> Word32

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

-> m ()

These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

setPriorityFlowControl

settingDcbSetPriorityFlowControl

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> Bool

enabled: True to enable flow control for this priority, False to disable it

-> m ()

These values are only valid when SettingDcb:priorityFlowControl includes the SettingDcbFlagsEnable flag.

setPriorityGroupBandwidth

settingDcbSetPriorityGroupBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> Word32

bandwidthPercent: the bandwidth percentage (0 - 100) to assign to groupId to

-> m ()

These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

setPriorityGroupId

settingDcbSetPriorityGroupId

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> Word32

groupId: the group (0 - 7) to assign userPriority to, or 15 for the unrestricted group.

-> m ()

These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

setPriorityStrictBandwidth

settingDcbSetPriorityStrictBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsSettingDcb a)

=> a

setting: the SettingDcb

-> Word32

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

-> Bool

strict: True to allow userPriority to use all the bandwidth allocated to its priority group, or False if not

-> m ()

These values are only valid when SettingDcb:priorityGroupFlags includes the SettingDcbFlagsEnable flag.

setPriorityTrafficClass

settingDcbSetPriorityTrafficClass :: (HasCallStack, MonadIO m, IsSettingDcb a) => a -> Word32 -> Word32 -> m ()

No description available in the introspection data.

Properties

appFcoeFlags

Specifies the SettingDcbFlags for the DCB FCoE application. Flags may be any combination of SettingDcbFlagsEnable, SettingDcbFlagsAdvertise, and SettingDcbFlagsWilling.

constructSettingDcbAppFcoeFlags :: (IsSettingDcb o, MonadIO m) => [SettingDcbFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-fcoe-flags” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppFcoeFlags :: (MonadIO m, IsSettingDcb o) => o -> m [SettingDcbFlags]

Get the value of the “app-fcoe-flags” property. When overloading is enabled, this is equivalent to

get settingDcb #appFcoeFlags

setSettingDcbAppFcoeFlags :: (MonadIO m, IsSettingDcb o) => o -> [SettingDcbFlags] -> m ()

Set the value of the “app-fcoe-flags” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appFcoeFlags := value ]

appFcoeMode

The FCoE controller mode; either SETTING_DCB_FCOE_MODE_FABRIC or SETTING_DCB_FCOE_MODE_VN2VN.

Since 1.34, Nothing is the default and means SETTING_DCB_FCOE_MODE_FABRIC. Before 1.34, Nothing was rejected as invalid and the default was SETTING_DCB_FCOE_MODE_FABRIC.

clearSettingDcbAppFcoeMode :: (MonadIO m, IsSettingDcb o) => o -> m ()

Set the value of the “app-fcoe-mode” property to Nothing. When overloading is enabled, this is equivalent to

clear #appFcoeMode

constructSettingDcbAppFcoeMode :: (IsSettingDcb o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-fcoe-mode” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppFcoeMode :: (MonadIO m, IsSettingDcb o) => o -> m Text

Get the value of the “app-fcoe-mode” property. When overloading is enabled, this is equivalent to

get settingDcb #appFcoeMode

setSettingDcbAppFcoeMode :: (MonadIO m, IsSettingDcb o) => o -> Text -> m ()

Set the value of the “app-fcoe-mode” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appFcoeMode := value ]

appFcoePriority

The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the SettingDcb:appFcoeFlags property includes the SettingDcbFlagsEnable flag.

constructSettingDcbAppFcoePriority :: (IsSettingDcb o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-fcoe-priority” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppFcoePriority :: (MonadIO m, IsSettingDcb o) => o -> m Int32

Get the value of the “app-fcoe-priority” property. When overloading is enabled, this is equivalent to

get settingDcb #appFcoePriority

setSettingDcbAppFcoePriority :: (MonadIO m, IsSettingDcb o) => o -> Int32 -> m ()

Set the value of the “app-fcoe-priority” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appFcoePriority := value ]

appFipFlags

Specifies the SettingDcbFlags for the DCB FIP application. Flags may be any combination of SettingDcbFlagsEnable, SettingDcbFlagsAdvertise, and SettingDcbFlagsWilling.

constructSettingDcbAppFipFlags :: (IsSettingDcb o, MonadIO m) => [SettingDcbFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-fip-flags” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppFipFlags :: (MonadIO m, IsSettingDcb o) => o -> m [SettingDcbFlags]

Get the value of the “app-fip-flags” property. When overloading is enabled, this is equivalent to

get settingDcb #appFipFlags

setSettingDcbAppFipFlags :: (MonadIO m, IsSettingDcb o) => o -> [SettingDcbFlags] -> m ()

Set the value of the “app-fip-flags” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appFipFlags := value ]

appFipPriority

The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the SettingDcb:appFipFlags property includes the SettingDcbFlagsEnable flag.

constructSettingDcbAppFipPriority :: (IsSettingDcb o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-fip-priority” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppFipPriority :: (MonadIO m, IsSettingDcb o) => o -> m Int32

Get the value of the “app-fip-priority” property. When overloading is enabled, this is equivalent to

get settingDcb #appFipPriority

setSettingDcbAppFipPriority :: (MonadIO m, IsSettingDcb o) => o -> Int32 -> m ()

Set the value of the “app-fip-priority” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appFipPriority := value ]

appIscsiFlags

Specifies the SettingDcbFlags for the DCB iSCSI application. Flags may be any combination of SettingDcbFlagsEnable, SettingDcbFlagsAdvertise, and SettingDcbFlagsWilling.

constructSettingDcbAppIscsiFlags :: (IsSettingDcb o, MonadIO m) => [SettingDcbFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-iscsi-flags” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppIscsiFlags :: (MonadIO m, IsSettingDcb o) => o -> m [SettingDcbFlags]

Get the value of the “app-iscsi-flags” property. When overloading is enabled, this is equivalent to

get settingDcb #appIscsiFlags

setSettingDcbAppIscsiFlags :: (MonadIO m, IsSettingDcb o) => o -> [SettingDcbFlags] -> m ()

Set the value of the “app-iscsi-flags” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appIscsiFlags := value ]

appIscsiPriority

The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the SettingDcb:appIscsiFlags property includes the SettingDcbFlagsEnable flag.

constructSettingDcbAppIscsiPriority :: (IsSettingDcb o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “app-iscsi-priority” property. This is rarely needed directly, but it is used by new.

getSettingDcbAppIscsiPriority :: (MonadIO m, IsSettingDcb o) => o -> m Int32

Get the value of the “app-iscsi-priority” property. When overloading is enabled, this is equivalent to

get settingDcb #appIscsiPriority

setSettingDcbAppIscsiPriority :: (MonadIO m, IsSettingDcb o) => o -> Int32 -> m ()

Set the value of the “app-iscsi-priority” property. When overloading is enabled, this is equivalent to

set settingDcb [ #appIscsiPriority := value ]

priorityBandwidth

priorityFlowControl

priorityFlowControlFlags

Specifies the SettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of SettingDcbFlagsEnable, SettingDcbFlagsAdvertise, and SettingDcbFlagsWilling.

constructSettingDcbPriorityFlowControlFlags :: (IsSettingDcb o, MonadIO m) => [SettingDcbFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “priority-flow-control-flags” property. This is rarely needed directly, but it is used by new.

getSettingDcbPriorityFlowControlFlags :: (MonadIO m, IsSettingDcb o) => o -> m [SettingDcbFlags]

Get the value of the “priority-flow-control-flags” property. When overloading is enabled, this is equivalent to

get settingDcb #priorityFlowControlFlags

setSettingDcbPriorityFlowControlFlags :: (MonadIO m, IsSettingDcb o) => o -> [SettingDcbFlags] -> m ()

Set the value of the “priority-flow-control-flags” property. When overloading is enabled, this is equivalent to

set settingDcb [ #priorityFlowControlFlags := value ]

priorityGroupBandwidth

priorityGroupFlags

Specifies the SettingDcbFlags for DCB Priority Groups. Flags may be any combination of SettingDcbFlagsEnable, SettingDcbFlagsAdvertise, and SettingDcbFlagsWilling.

constructSettingDcbPriorityGroupFlags :: (IsSettingDcb o, MonadIO m) => [SettingDcbFlags] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “priority-group-flags” property. This is rarely needed directly, but it is used by new.

getSettingDcbPriorityGroupFlags :: (MonadIO m, IsSettingDcb o) => o -> m [SettingDcbFlags]

Get the value of the “priority-group-flags” property. When overloading is enabled, this is equivalent to

get settingDcb #priorityGroupFlags

setSettingDcbPriorityGroupFlags :: (MonadIO m, IsSettingDcb o) => o -> [SettingDcbFlags] -> m ()

Set the value of the “priority-group-flags” property. When overloading is enabled, this is equivalent to

set settingDcb [ #priorityGroupFlags := value ]

priorityGroupId

priorityStrictBandwidth

priorityTrafficClass