GI.NM.Structs.SriovVF

No description available in the introspection data.

Exported types

newtype SriovVF

Memory-managed wrapper type.

Constructors

SriovVF (ManagedPtr SriovVF)

Instances

Eq SriovVF

Defined in GI.NM.Structs.SriovVF

Methods

(==) :: SriovVF -> SriovVF -> Bool

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

GBoxed SriovVF

Defined in GI.NM.Structs.SriovVF

ManagedPtrNewtype SriovVF

Defined in GI.NM.Structs.SriovVF

Methods

toManagedPtr :: SriovVF -> ManagedPtr SriovVF

TypedObject SriovVF

Defined in GI.NM.Structs.SriovVF

Methods

glibType :: IO GType

HasParentTypes SriovVF

Defined in GI.NM.Structs.SriovVF

IsGValue (Maybe SriovVF)

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

Defined in GI.NM.Structs.SriovVF

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SriovVF

Defined in GI.NM.Structs.SriovVF

type ParentTypes SriovVF = '[] :: [Type]

Methods

Click to display all available methods, including inherited ones

Methods

addVlan, dup, equal, ref, removeVlan, unref.

Getters

getAttribute, getAttributeNames, getIndex, getVlanIds, getVlanProtocol, getVlanQos.

Setters

setAttribute, setVlanProtocol, setVlanQos.

addVlan

sriovVFAddVlan

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> m Bool

Returns: True if the VLAN was added; False if it already existed

Adds a VLAN to the VF. Currently kernel only supports one VLAN per VF.

Since: 1.14

attributeValidate

sriovVFAttributeValidate

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: the attribute name

-> GVariant

value: the attribute value

-> m Bool

(Can throw GError)

Validates a VF attribute, i.e. checks that the attribute is a known one, the value is of the correct type and well-formed.

Since: 1.42

dup

sriovVFDup

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m SriovVF

Returns: a copy of vf

Creates a copy of vf.

Since: 1.14

equal

sriovVFEqual

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> SriovVF

other: the SriovVF to compare vf to.

-> m Bool

Returns: True if the objects contain the same values, False if they do not.

Determines if two SriovVF objects have the same index, attributes and VLANs.

Since: 1.14

getAttribute

sriovVFGetAttribute

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Text

name: the name of a VF attribute

-> m GVariant

Returns: the value of the attribute with name name on vf, or Nothing if vf has no such attribute.

Gets the value of the attribute with name name on vf

Since: 1.14

getAttributeNames

sriovVFGetAttributeNames

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m [Text]

Returns: a Nothing-terminated array of attribute names

Gets an array of attribute names defined on vf.

Since: 1.14

getIndex

sriovVFGetIndex

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m Word32

Returns: the VF index

Gets the index property of this VF object.

Since: 1.14

getVlanIds

sriovVFGetVlanIds

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m [Word32]

Returns: a list of VLAN ids configured on the VF.

Returns the VLANs currently configured on the VF. Currently kernel only supports one VLAN per VF.

Since: 1.14

getVlanProtocol

sriovVFGetVlanProtocol

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> m SriovVFVlanProtocol

Returns: the configured protocol

Returns the configured protocol for the given VLAN.

Since: 1.14

getVlanQos

sriovVFGetVlanQos

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> m Word32

Returns: the QoS value

Returns the QoS value for the given VLAN.

Since: 1.14

new

sriovVFNew

Arguments

:: (HasCallStack, MonadIO m)

=> Word32

index: the VF index

-> m SriovVF

Returns: the new SriovVF object.

Creates a new SriovVF object.

Since: 1.14

ref

sriovVFRef

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m ()

Increases the reference count of the object.

Since: 1.14

removeVlan

sriovVFRemoveVlan

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> m Bool

Returns: True if the VLAN was removed, False if the VLAN vlanId did not belong to the VF.

Removes a VLAN from a VF.

Since: 1.14

setAttribute

sriovVFSetAttribute

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Text

name: the name of a route attribute

-> Maybe GVariant

value: the value

-> m ()

Sets the named attribute on vf to the given value.

Since: 1.14

setVlanProtocol

sriovVFSetVlanProtocol

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> SriovVFVlanProtocol

protocol: the VLAN protocol

-> m ()

Sets the protocol for the given VLAN.

Since: 1.14

setVlanQos

sriovVFSetVlanQos

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> Word32

vlanId: the VLAN id

-> Word32

qos: a QoS (priority) value

-> m ()

Sets a QoS value for the given VLAN.

Since: 1.14

unref

sriovVFUnref

Arguments

:: (HasCallStack, MonadIO m)

=> SriovVF

vf: the SriovVF

-> m ()

Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Since: 1.14