GI.NM.Structs.BridgeVlan

No description available in the introspection data.

Exported types

newtype BridgeVlan

Memory-managed wrapper type.

Constructors

BridgeVlan (ManagedPtr BridgeVlan)

Instances

Eq BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

Methods

(==) :: BridgeVlan -> BridgeVlan -> Bool

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

GBoxed BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

ManagedPtrNewtype BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

Methods

toManagedPtr :: BridgeVlan -> ManagedPtr BridgeVlan

TypedObject BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

Methods

glibType :: IO GType

HasParentTypes BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

IsGValue (Maybe BridgeVlan)

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

Defined in GI.NM.Structs.BridgeVlan

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes BridgeVlan

Defined in GI.NM.Structs.BridgeVlan

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

Methods

Click to display all available methods, including inherited ones

Methods

cmp, isPvid, isSealed, isUntagged, newClone, ref, seal, toStr, unref.

Getters

getVidRange.

Setters

setPvid, setUntagged.

cmp

bridgeVlanCmp

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

a: a BridgeVlan

-> BridgeVlan

b: another BridgeVlan

-> m Int32

Returns: zero of the two instances are equivalent or a non-zero integer otherwise. This defines a total ordering over the VLANs. Whether a VLAN is sealed or not does not affect the comparison.

Compare two bridge VLAN objects.

Since: 1.18

fromStr

bridgeVlanFromStr

Arguments

:: (HasCallStack, MonadIO m)

=> Text

str: the string representation of a bridge VLAN

-> m BridgeVlan

Returns: the NMBridgeVlan or Nothing (Can throw GError)

Parses the string representation of the queueing discipline to a NMBridgeVlan instance.

Since: 1.18

getVidRange

bridgeVlanGetVidRange

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> m (Bool, Word16, Word16)

Returns: True is the VLAN specifies a range, False if it is a single-id VLAN.

Gets the VLAN id range.

Since: 1.18

isPvid

bridgeVlanIsPvid

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> m Bool

Returns: True if the VLAN is the PVID

Returns whether the VLAN is the PVID for the port.

Since: 1.18

isSealed

bridgeVlanIsSealed

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan instance

-> m Bool

Returns: whether self is sealed or not.

No description available in the introspection data.

Since: 1.18

isUntagged

bridgeVlanIsUntagged

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> m Bool

Returns: True if the VLAN is untagged, False otherwise

Returns whether the VLAN is untagged.

Since: 1.18

new

bridgeVlanNew

Arguments

:: (HasCallStack, MonadIO m)

=> Word16

vidStart: the start VLAN id, must be between 1 and 4094.

-> Word16

vidEnd: the end VLAN id, must be 0 or between vidStart and 4094.

-> m BridgeVlan

Returns: the new BridgeVlan object.

Creates a new BridgeVlan object for the given VLAN id range. Setting vidEnd to 0 is equivalent to setting it to vidStart and creates a single-id VLAN.

Since 1.42, ref-counting of BridgeVlan is thread-safe.

Since: 1.18

newClone

bridgeVlanNewClone

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan instance to copy

-> m BridgeVlan

Returns: a clone of vlan. This instance is always unsealed.

No description available in the introspection data.

Since: 1.18

ref

bridgeVlanRef

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> m BridgeVlan

Returns: the input argument vlan object.

Since 1.42, ref-counting of BridgeVlan is thread-safe.

Increases the reference count of the object.

Since: 1.18

seal

bridgeVlanSeal

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan instance

-> m ()

Seal the BridgeVlan instance. Afterwards, it is a bug to call all functions that modify the instance (except ref/unref). A sealed instance cannot be unsealed again, but you can create an unsealed copy with bridgeVlanNewClone.

Since: 1.18

setPvid

bridgeVlanSetPvid

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> Bool

value: the new value

-> m ()

Change the value of the PVID property of the VLAN. It is invalid to set the value to True for non-single-id VLANs.

Since: 1.18

setUntagged

bridgeVlanSetUntagged

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> Bool

value: the new value

-> m ()

Change the value of the untagged property of the VLAN.

Since: 1.18

toStr

bridgeVlanToStr

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the NMBridgeVlan

-> m Text

Returns: formatted string or Nothing (Can throw GError)

Convert a NMBridgeVlan to a string.

Since: 1.18

unref

bridgeVlanUnref

Arguments

:: (HasCallStack, MonadIO m)

=> BridgeVlan

vlan: the BridgeVlan

-> m ()

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

Since 1.42, ref-counting of BridgeVlan is thread-safe.

Since: 1.18