gi-nm-1.0.1: NM bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.NM.Objects.SettingTeam

Description

Teaming Settings

Synopsis

Exported types

newtype SettingTeam Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf SettingTeam o) => IsSettingTeam o Source #

Type class for types which can be safely cast to SettingTeam, for instance with toSettingTeam.

Instances

Instances details
(GObject o, IsDescendantOf SettingTeam o) => IsSettingTeam o Source # 
Instance details

Defined in GI.NM.Objects.SettingTeam

toSettingTeam :: (MonadIO m, IsSettingTeam o) => o -> m SettingTeam Source #

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

Methods

addLinkWatcher

settingTeamAddLinkWatcher Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> 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

addRunnerTxHash

settingTeamAddRunnerTxHash Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> Text

txhash: the element to add to txhash

-> m Bool

Returns: True if the txhash element was added; False if the element was already knnown.

Adds a new txhash element to the setting.

Since: 1.12

clearLinkWatchers

settingTeamClearLinkWatchers Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m () 

Removes all configured link watchers.

Since: 1.12

getConfig

settingTeamGetConfig Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Text

Returns: the SettingTeam:config property of the setting

No description available in the introspection data.

getLinkWatcher

settingTeamGetLinkWatcher Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> 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

getMcastRejoinCount

settingTeamGetMcastRejoinCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:mcastRejoinCount") property of the setting

No description available in the introspection data.

Since: 1.12

getMcastRejoinInterval

settingTeamGetMcastRejoinInterval Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:mcastRejoinInterval") property of the setting

No description available in the introspection data.

Since: 1.12

getNotifyPeersCount

settingTeamGetNotifyPeersCount Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:notifyPeersCount") property of the setting

No description available in the introspection data.

Since: 1.12

getNotifyPeersInterval

settingTeamGetNotifyPeersInterval Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:notifyPeersInterval") property of the setting

No description available in the introspection data.

Since: 1.12

getNumLinkWatchers

settingTeamGetNumLinkWatchers Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Word32

Returns: the number of configured link watchers

No description available in the introspection data.

Since: 1.12

getNumRunnerTxHash

settingTeamGetNumRunnerTxHash Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Word32

Returns: the number of elements in txhash

No description available in the introspection data.

Since: 1.12

getRunner

settingTeamGetRunner Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Text

Returns: the g:attr:runner") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerActive

settingTeamGetRunnerActive Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Bool

Returns: the #SettingTeam:runner_active property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerAggSelectPolicy

settingTeamGetRunnerAggSelectPolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Text

Returns: the g:attr:runnerAggSelectPolicy") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerFastRate

settingTeamGetRunnerFastRate Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Bool

Returns: the g:attr:runnerFastRate") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerHwaddrPolicy

settingTeamGetRunnerHwaddrPolicy Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Text

Returns: the g:attr:runnerHwaddrPolicy") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerMinPorts

settingTeamGetRunnerMinPorts Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:runnerMinPorts") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerSysPrio

settingTeamGetRunnerSysPrio Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the g:attr:runnerSysPrio") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerTxBalancer

settingTeamGetRunnerTxBalancer Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Text

Returns: the g:attr:runnerTxBalancer") property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerTxBalancerInterval

settingTeamGetRunnerTxBalancerInterval Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> m Int32

Returns: the #SettingTeam:runner-tx-balancer_interval property of the setting

No description available in the introspection data.

Since: 1.12

getRunnerTxHash

settingTeamGetRunnerTxHash Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> Word32

idx: index number of the txhash element to return

-> m Text

Returns: the txhash element at index idx

No description available in the introspection data.

Since: 1.12

new

settingTeamNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m SettingTeam

Returns: the new empty SettingTeam object

Creates a new SettingTeam object with default values.

removeLinkWatcher

settingTeamRemoveLinkWatcher Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> Word32

idx: index number of the link watcher to remove

-> m () 

Removes the link watcher at index idx.

Since: 1.12

removeLinkWatcherByValue

settingTeamRemoveLinkWatcherByValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> 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

removeRunnerTxHash

settingTeamRemoveRunnerTxHash Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the SettingTeam

-> Word32

idx: index number of the element to remove from txhash

-> m () 

Removes the txhash element at index idx.

Since: 1.12

removeRunnerTxHashByValue

settingTeamRemoveRunnerTxHashByValue Source #

Arguments

:: (HasCallStack, MonadIO m, IsSettingTeam a) 
=> a

setting: the NMSetetingTeam

-> Text

txhash: the txhash element to remove

-> m Bool

Returns: True if the txhash element was found and removed; False if it was not.

Removes the txhash element txhash

Since: 1.12

Properties

config

The JSON configuration for the team network interface. 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.

clearSettingTeamConfig :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

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

clear #config

constructSettingTeamConfig :: (IsSettingTeam o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingTeamConfig :: (MonadIO m, IsSettingTeam o) => o -> m Text Source #

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

get settingTeam #config

setSettingTeamConfig :: (MonadIO m, IsSettingTeam o) => o -> Text -> m () Source #

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

set settingTeam [ #config := value ]

linkWatchers

mcastRejoinCount

Corresponds to the teamd mcast_rejoin.count.

Since: 1.12

constructSettingTeamMcastRejoinCount :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamMcastRejoinCount :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “mcast-rejoin-count” property. When overloading is enabled, this is equivalent to

get settingTeam #mcastRejoinCount

setSettingTeamMcastRejoinCount :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “mcast-rejoin-count” property. When overloading is enabled, this is equivalent to

set settingTeam [ #mcastRejoinCount := value ]

mcastRejoinInterval

Corresponds to the teamd mcast_rejoin.interval.

Since: 1.12

constructSettingTeamMcastRejoinInterval :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamMcastRejoinInterval :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “mcast-rejoin-interval” property. When overloading is enabled, this is equivalent to

get settingTeam #mcastRejoinInterval

setSettingTeamMcastRejoinInterval :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “mcast-rejoin-interval” property. When overloading is enabled, this is equivalent to

set settingTeam [ #mcastRejoinInterval := value ]

notifyPeersCount

Corresponds to the teamd notify_peers.count.

Since: 1.12

constructSettingTeamNotifyPeersCount :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamNotifyPeersCount :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “notify-peers-count” property. When overloading is enabled, this is equivalent to

get settingTeam #notifyPeersCount

setSettingTeamNotifyPeersCount :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “notify-peers-count” property. When overloading is enabled, this is equivalent to

set settingTeam [ #notifyPeersCount := value ]

notifyPeersInterval

Corresponds to the teamd notify_peers.interval.

Since: 1.12

constructSettingTeamNotifyPeersInterval :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamNotifyPeersInterval :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “notify-peers-interval” property. When overloading is enabled, this is equivalent to

get settingTeam #notifyPeersInterval

setSettingTeamNotifyPeersInterval :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “notify-peers-interval” property. When overloading is enabled, this is equivalent to

set settingTeam [ #notifyPeersInterval := value ]

runner

Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".

Since: 1.12

clearSettingTeamRunner :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

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

clear #runner

constructSettingTeamRunner :: (IsSettingTeam o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingTeamRunner :: (MonadIO m, IsSettingTeam o) => o -> m Text Source #

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

get settingTeam #runner

setSettingTeamRunner :: (MonadIO m, IsSettingTeam o) => o -> Text -> m () Source #

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

set settingTeam [ #runner := value ]

runnerActive

Corresponds to the teamd runner.active.

Since: 1.12

constructSettingTeamRunnerActive :: (IsSettingTeam o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerActive :: (MonadIO m, IsSettingTeam o) => o -> m Bool Source #

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

get settingTeam #runnerActive

setSettingTeamRunnerActive :: (MonadIO m, IsSettingTeam o) => o -> Bool -> m () Source #

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

set settingTeam [ #runnerActive := value ]

runnerAggSelectPolicy

Corresponds to the teamd runner.agg_select_policy.

Since: 1.12

clearSettingTeamRunnerAggSelectPolicy :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

Set the value of the “runner-agg-select-policy” property to Nothing. When overloading is enabled, this is equivalent to

clear #runnerAggSelectPolicy

constructSettingTeamRunnerAggSelectPolicy :: (IsSettingTeam o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerAggSelectPolicy :: (MonadIO m, IsSettingTeam o) => o -> m Text Source #

Get the value of the “runner-agg-select-policy” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerAggSelectPolicy

setSettingTeamRunnerAggSelectPolicy :: (MonadIO m, IsSettingTeam o) => o -> Text -> m () Source #

Set the value of the “runner-agg-select-policy” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerAggSelectPolicy := value ]

runnerFastRate

Corresponds to the teamd runner.fast_rate.

Since: 1.12

constructSettingTeamRunnerFastRate :: (IsSettingTeam o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerFastRate :: (MonadIO m, IsSettingTeam o) => o -> m Bool Source #

Get the value of the “runner-fast-rate” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerFastRate

setSettingTeamRunnerFastRate :: (MonadIO m, IsSettingTeam o) => o -> Bool -> m () Source #

Set the value of the “runner-fast-rate” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerFastRate := value ]

runnerHwaddrPolicy

Corresponds to the teamd runner.hwaddr_policy.

Since: 1.12

clearSettingTeamRunnerHwaddrPolicy :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

Set the value of the “runner-hwaddr-policy” property to Nothing. When overloading is enabled, this is equivalent to

clear #runnerHwaddrPolicy

constructSettingTeamRunnerHwaddrPolicy :: (IsSettingTeam o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerHwaddrPolicy :: (MonadIO m, IsSettingTeam o) => o -> m Text Source #

Get the value of the “runner-hwaddr-policy” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerHwaddrPolicy

setSettingTeamRunnerHwaddrPolicy :: (MonadIO m, IsSettingTeam o) => o -> Text -> m () Source #

Set the value of the “runner-hwaddr-policy” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerHwaddrPolicy := value ]

runnerMinPorts

Corresponds to the teamd runner.min_ports.

Since: 1.12

constructSettingTeamRunnerMinPorts :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerMinPorts :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “runner-min-ports” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerMinPorts

setSettingTeamRunnerMinPorts :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “runner-min-ports” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerMinPorts := value ]

runnerSysPrio

Corresponds to the teamd runner.sys_prio.

Since: 1.12

constructSettingTeamRunnerSysPrio :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerSysPrio :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

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

get settingTeam #runnerSysPrio

setSettingTeamRunnerSysPrio :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

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

set settingTeam [ #runnerSysPrio := value ]

runnerTxBalancer

Corresponds to the teamd runner.tx_balancer.name.

Since: 1.12

clearSettingTeamRunnerTxBalancer :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

Set the value of the “runner-tx-balancer” property to Nothing. When overloading is enabled, this is equivalent to

clear #runnerTxBalancer

constructSettingTeamRunnerTxBalancer :: (IsSettingTeam o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerTxBalancer :: (MonadIO m, IsSettingTeam o) => o -> m Text Source #

Get the value of the “runner-tx-balancer” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerTxBalancer

setSettingTeamRunnerTxBalancer :: (MonadIO m, IsSettingTeam o) => o -> Text -> m () Source #

Set the value of the “runner-tx-balancer” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerTxBalancer := value ]

runnerTxBalancerInterval

Corresponds to the teamd runner.tx_balancer.interval.

Since: 1.12

constructSettingTeamRunnerTxBalancerInterval :: (IsSettingTeam o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerTxBalancerInterval :: (MonadIO m, IsSettingTeam o) => o -> m Int32 Source #

Get the value of the “runner-tx-balancer-interval” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerTxBalancerInterval

setSettingTeamRunnerTxBalancerInterval :: (MonadIO m, IsSettingTeam o) => o -> Int32 -> m () Source #

Set the value of the “runner-tx-balancer-interval” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerTxBalancerInterval := value ]

runnerTxHash

Corresponds to the teamd runner.tx_hash.

Since: 1.12

clearSettingTeamRunnerTxHash :: (MonadIO m, IsSettingTeam o) => o -> m () Source #

Set the value of the “runner-tx-hash” property to Nothing. When overloading is enabled, this is equivalent to

clear #runnerTxHash

constructSettingTeamRunnerTxHash :: (IsSettingTeam o, MonadIO m) => [Text] -> m (GValueConstruct o) Source #

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

getSettingTeamRunnerTxHash :: (MonadIO m, IsSettingTeam o) => o -> m (Maybe [Text]) Source #

Get the value of the “runner-tx-hash” property. When overloading is enabled, this is equivalent to

get settingTeam #runnerTxHash

setSettingTeamRunnerTxHash :: (MonadIO m, IsSettingTeam o) => o -> [Text] -> m () Source #

Set the value of the “runner-tx-hash” property. When overloading is enabled, this is equivalent to

set settingTeam [ #runnerTxHash := value ]