GI.NM.Objects.SettingBridgePort

Bridge Port Settings

Exported types

newtype SettingBridgePort

Memory-managed wrapper type.

Constructors

SettingBridgePort (ManagedPtr SettingBridgePort)

Instances

Eq SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

Methods

(==) :: SettingBridgePort -> SettingBridgePort -> Bool

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

GObject SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

ManagedPtrNewtype SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

Methods

toManagedPtr :: SettingBridgePort -> ManagedPtr SettingBridgePort

TypedObject SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

Methods

glibType :: IO GType

HasParentTypes SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

IsGValue (Maybe SettingBridgePort)

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

Defined in GI.NM.Objects.SettingBridgePort

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingBridgePort

Defined in GI.NM.Objects.SettingBridgePort

type ParentTypes SettingBridgePort = '[Setting, Object]

class (GObject o, IsDescendantOf SettingBridgePort o) => IsSettingBridgePort o

Type class for types which can be safely cast to SettingBridgePort, for instance with toSettingBridgePort.

Instances

(GObject o, IsDescendantOf SettingBridgePort o) => IsSettingBridgePort o

Defined in GI.NM.Objects.SettingBridgePort

toSettingBridgePort :: (MonadIO m, IsSettingBridgePort o) => o -> m SettingBridgePort

Cast to SettingBridgePort, 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

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

Getters

getData, getDbusPropertyType, getHairpinMode, getName, getNumVlans, getPathCost, getPriority, getProperty, getQdata, getSecretFlags, getVlan.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addVlan

settingBridgePortAddVlan

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> BridgeVlan

vlan: the vlan to add

-> m ()

Appends a new vlan and associated information to the setting. The given vlan gets sealed and a reference to it is added.

Since: 1.18

clearVlans

settingBridgePortClearVlans

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> m ()

Removes all configured VLANs.

Since: 1.18

getHairpinMode

settingBridgePortGetHairpinMode

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> m Bool

Returns: the SettingBridgePort:hairpinMode property of the setting

No description available in the introspection data.

getNumVlans

settingBridgePortGetNumVlans

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> m Word32

Returns: the number of VLANs

No description available in the introspection data.

Since: 1.18

getPathCost

settingBridgePortGetPathCost

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> m Word16

Returns: the SettingBridgePort:pathCost property of the setting

No description available in the introspection data.

getPriority

settingBridgePortGetPriority

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> m Word16

Returns: the SettingBridgePort:priority property of the setting

No description available in the introspection data.

getVlan

settingBridgePortGetVlan

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> Word32

idx: index number of the VLAN to return

-> m BridgeVlan

Returns: the VLAN at index idx

No description available in the introspection data.

Since: 1.18

new

settingBridgePortNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingBridgePort

Returns: the new empty SettingBridgePort object

Creates a new SettingBridgePort object with default values.

removeVlan

settingBridgePortRemoveVlan

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> Word32

idx: index number of the VLAN.

-> m ()

Removes the vlan at index idx.

Since: 1.18

removeVlanByVid

settingBridgePortRemoveVlanByVid

Arguments

:: (HasCallStack, MonadIO m, IsSettingBridgePort a)

=> a

setting: the SettingBridgePort

-> Word16

vidStart: the vlan start index

-> Word16

vidEnd: the vlan end index

-> m Bool

Returns: True if the vlan was found and removed; False otherwise

Remove the VLAN with range vidStart to vidEnd. If vidEnd is zero, it is assumed to be equal to vidStart and so the single-id VLAN with id vidStart is removed.

Since: 1.18

Properties

hairpinMode

Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.

constructSettingBridgePortHairpinMode :: (IsSettingBridgePort o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingBridgePortHairpinMode :: (MonadIO m, IsSettingBridgePort o) => o -> m Bool

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

get settingBridgePort #hairpinMode

setSettingBridgePortHairpinMode :: (MonadIO m, IsSettingBridgePort o) => o -> Bool -> m ()

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

set settingBridgePort [ #hairpinMode := value ]

pathCost

The Spanning Tree Protocol (STP) port cost for destinations via this port.

constructSettingBridgePortPathCost :: (IsSettingBridgePort o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingBridgePortPathCost :: (MonadIO m, IsSettingBridgePort o) => o -> m Word32

Get the value of the “path-cost” property. When overloading is enabled, this is equivalent to

get settingBridgePort #pathCost

setSettingBridgePortPathCost :: (MonadIO m, IsSettingBridgePort o) => o -> Word32 -> m ()

Set the value of the “path-cost” property. When overloading is enabled, this is equivalent to

set settingBridgePort [ #pathCost := value ]

priority

The Spanning Tree Protocol (STP) priority of this bridge port.

constructSettingBridgePortPriority :: (IsSettingBridgePort o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getSettingBridgePortPriority :: (MonadIO m, IsSettingBridgePort o) => o -> m Word32

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

get settingBridgePort #priority

setSettingBridgePortPriority :: (MonadIO m, IsSettingBridgePort o) => o -> Word32 -> m ()

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

set settingBridgePort [ #priority := value ]

vlans