GI.NM.Objects.SettingTeamPort

Team Port Settings

Exported types

newtype SettingTeamPort

Memory-managed wrapper type.

Constructors

SettingTeamPort (ManagedPtr SettingTeamPort)

Instances

Eq SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

Methods

(==) :: SettingTeamPort -> SettingTeamPort -> Bool

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

GObject SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

ManagedPtrNewtype SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

Methods

toManagedPtr :: SettingTeamPort -> ManagedPtr SettingTeamPort

TypedObject SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

Methods

glibType :: IO GType

HasParentTypes SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

IsGValue (Maybe SettingTeamPort)

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

Defined in GI.NM.Objects.SettingTeamPort

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes SettingTeamPort

Defined in GI.NM.Objects.SettingTeamPort

type ParentTypes SettingTeamPort = '[Setting, Object]

class (GObject o, IsDescendantOf SettingTeamPort o) => IsSettingTeamPort o

Type class for types which can be safely cast to SettingTeamPort, for instance with toSettingTeamPort.

Instances

(GObject o, IsDescendantOf SettingTeamPort o) => IsSettingTeamPort o

Defined in GI.NM.Objects.SettingTeamPort

toSettingTeamPort :: (MonadIO m, IsSettingTeamPort o) => o -> m SettingTeamPort

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

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

Getters

getConfig, getData, getDbusPropertyType, getLacpKey, getLacpPrio, getLinkWatcher, getName, getNumLinkWatchers, getPrio, getProperty, getQdata, getQueueId, getSecretFlags, getSticky.

Setters

setData, setDataFull, setProperty, setSecretFlags.

addLinkWatcher

settingTeamPortAddLinkWatcher

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> TeamLinkWatcher

linkWatcher: the link watcher to add

-> m Bool

Returns: True if the link watcher is added; False if an identical link watcher was already there.

Appends a new link watcher to the setting.

Since: 1.12

clearLinkWatchers

settingTeamPortClearLinkWatchers

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m ()

Removes all configured link watchers.

Since: 1.12

getConfig

settingTeamPortGetConfig

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Text

Returns: the SettingTeamPort:config property of the setting

No description available in the introspection data.

getLacpKey

settingTeamPortGetLacpKey

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Int32

Returns: the SettingTeamPort:lacpKey property of the setting

No description available in the introspection data.

Since: 1.12

getLacpPrio

settingTeamPortGetLacpPrio

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Int32

Returns: the SettingTeamPort:lacpPrio property of the setting

No description available in the introspection data.

Since: 1.12

getLinkWatcher

settingTeamPortGetLinkWatcher

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> Word32

idx: index number of the link watcher to return

-> m TeamLinkWatcher

Returns: the link watcher at index idx.

No description available in the introspection data.

Since: 1.12

getNumLinkWatchers

settingTeamPortGetNumLinkWatchers

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Word32

Returns: the number of configured link watchers

No description available in the introspection data.

Since: 1.12

getPrio

settingTeamPortGetPrio

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Int32

Returns: the SettingTeamPort:prio property of the setting

No description available in the introspection data.

Since: 1.12

getQueueId

settingTeamPortGetQueueId

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Int32

Returns: the SettingTeamPort:queue_id property of the setting

No description available in the introspection data.

Since: 1.12

getSticky

settingTeamPortGetSticky

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> m Bool

Returns: the SettingTeamPort:sticky property of the setting

No description available in the introspection data.

Since: 1.12

new

settingTeamPortNew

Arguments

:: (HasCallStack, MonadIO m)

=> m SettingTeamPort

Returns: the new empty SettingTeamPort object

Creates a new SettingTeamPort object with default values.

removeLinkWatcher

settingTeamPortRemoveLinkWatcher

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> Word32

idx: index number of the link watcher to remove

-> m ()

Removes the link watcher at index idx.

Since: 1.12

removeLinkWatcherByValue

settingTeamPortRemoveLinkWatcherByValue

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeamPort a)

=> a

setting: the SettingTeamPort

-> TeamLinkWatcher

linkWatcher: the link watcher to remove

-> m Bool

Returns: True if the link watcher was found and removed, False otherwise.

Removes the link watcher entry matching link_watcher.

Since: 1.12

Properties

config

The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.

clearSettingTeamPortConfig :: (MonadIO m, IsSettingTeamPort o) => o -> m ()

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

clear #config

constructSettingTeamPortConfig :: (IsSettingTeamPort o, MonadIO m) => Text -> m (GValueConstruct o)

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

getSettingTeamPortConfig :: (MonadIO m, IsSettingTeamPort o) => o -> m Text

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

get settingTeamPort #config

setSettingTeamPortConfig :: (MonadIO m, IsSettingTeamPort o) => o -> Text -> m ()

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

set settingTeamPort [ #config := value ]

lacpKey

Corresponds to the teamd ports.PORTIFNAME.lacp_key.

Since: 1.12

constructSettingTeamPortLacpKey :: (IsSettingTeamPort o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingTeamPortLacpKey :: (MonadIO m, IsSettingTeamPort o) => o -> m Int32

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

get settingTeamPort #lacpKey

setSettingTeamPortLacpKey :: (MonadIO m, IsSettingTeamPort o) => o -> Int32 -> m ()

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

set settingTeamPort [ #lacpKey := value ]

lacpPrio

Corresponds to the teamd ports.PORTIFNAME.lacp_prio.

Since: 1.12

constructSettingTeamPortLacpPrio :: (IsSettingTeamPort o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingTeamPortLacpPrio :: (MonadIO m, IsSettingTeamPort o) => o -> m Int32

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

get settingTeamPort #lacpPrio

setSettingTeamPortLacpPrio :: (MonadIO m, IsSettingTeamPort o) => o -> Int32 -> m ()

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

set settingTeamPort [ #lacpPrio := value ]

linkWatchers

prio

Corresponds to the teamd ports.PORTIFNAME.prio.

Since: 1.12

constructSettingTeamPortPrio :: (IsSettingTeamPort o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingTeamPortPrio :: (MonadIO m, IsSettingTeamPort o) => o -> m Int32

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

get settingTeamPort #prio

setSettingTeamPortPrio :: (MonadIO m, IsSettingTeamPort o) => o -> Int32 -> m ()

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

set settingTeamPort [ #prio := value ]

queueId

Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.

Since: 1.12

constructSettingTeamPortQueueId :: (IsSettingTeamPort o, MonadIO m) => Int32 -> m (GValueConstruct o)

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

getSettingTeamPortQueueId :: (MonadIO m, IsSettingTeamPort o) => o -> m Int32

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

get settingTeamPort #queueId

setSettingTeamPortQueueId :: (MonadIO m, IsSettingTeamPort o) => o -> Int32 -> m ()

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

set settingTeamPort [ #queueId := value ]

sticky

Corresponds to the teamd ports.PORTIFNAME.sticky.

Since: 1.12

constructSettingTeamPortSticky :: (IsSettingTeamPort o, MonadIO m) => Bool -> m (GValueConstruct o)

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

getSettingTeamPortSticky :: (MonadIO m, IsSettingTeamPort o) => o -> m Bool

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

get settingTeamPort #sticky

setSettingTeamPortSticky :: (MonadIO m, IsSettingTeamPort o) => o -> Bool -> m ()

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

set settingTeamPort [ #sticky := value ]