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

Description

HSR/PRP Settings

Synopsis

Exported types

newtype SettingHsr Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf SettingHsr o) => IsSettingHsr o Source #

Type class for types which can be safely cast to SettingHsr, for instance with toSettingHsr.

Instances

Instances details
(GObject o, IsDescendantOf SettingHsr o) => IsSettingHsr o Source # 
Instance details

Defined in GI.NM.Objects.SettingHsr

toSettingHsr :: (MonadIO m, IsSettingHsr o) => o -> m SettingHsr Source #

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

Methods

getMulticastSpec

settingHsrGetMulticastSpec Source #

Arguments

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

setting: the SettingHsr

-> m Word32

Returns: the SettingHsr:multicast_spec property of the setting

No description available in the introspection data.

Since: 1.46

getPort1

settingHsrGetPort1 Source #

Arguments

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

setting: the SettingHsr

-> m Text

Returns: the SettingHsr:port1 property of the setting

No description available in the introspection data.

Since: 1.46

getPort2

settingHsrGetPort2 Source #

Arguments

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

setting: the SettingHsr

-> m Text

Returns: the SettingHsr:port2 property of the setting

No description available in the introspection data.

Since: 1.46

getPrp

settingHsrGetPrp Source #

Arguments

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

setting: the SettingHsr

-> m Bool

Returns: the SettingHsr:prp property of the setting

No description available in the introspection data.

Since: 1.46

new

settingHsrNew Source #

Arguments

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

Returns: the new empty SettingHsr object

Creates a new SettingHsr object with default values.

Since: 1.46

Properties

multicastSpec

The last byte of supervision address.

Since: 1.46

constructSettingHsrMulticastSpec :: (IsSettingHsr o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingHsrMulticastSpec :: (MonadIO m, IsSettingHsr o) => o -> m Word32 Source #

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

get settingHsr #multicastSpec

setSettingHsrMulticastSpec :: (MonadIO m, IsSettingHsr o) => o -> Word32 -> m () Source #

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

set settingHsr [ #multicastSpec := value ]

port1

The port1 interface name of the HSR. This property is mandatory.

Since: 1.46

clearSettingHsrPort1 :: (MonadIO m, IsSettingHsr o) => o -> m () Source #

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

clear #port1

constructSettingHsrPort1 :: (IsSettingHsr o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingHsrPort1 :: (MonadIO m, IsSettingHsr o) => o -> m Text Source #

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

get settingHsr #port1

setSettingHsrPort1 :: (MonadIO m, IsSettingHsr o) => o -> Text -> m () Source #

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

set settingHsr [ #port1 := value ]

port2

The port2 interface name of the HSR. This property is mandatory.

Since: 1.46

clearSettingHsrPort2 :: (MonadIO m, IsSettingHsr o) => o -> m () Source #

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

clear #port2

constructSettingHsrPort2 :: (IsSettingHsr o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingHsrPort2 :: (MonadIO m, IsSettingHsr o) => o -> m Text Source #

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

get settingHsr #port2

setSettingHsrPort2 :: (MonadIO m, IsSettingHsr o) => o -> Text -> m () Source #

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

set settingHsr [ #port2 := value ]

prp

The protocol used by the interface, whether it is PRP or HSR.

Since: 1.46

constructSettingHsrPrp :: (IsSettingHsr o, MonadIO m) => Bool -> m (GValueConstruct o) Source #

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

getSettingHsrPrp :: (MonadIO m, IsSettingHsr o) => o -> m Bool Source #

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

get settingHsr #prp

setSettingHsrPrp :: (MonadIO m, IsSettingHsr o) => o -> Bool -> m () Source #

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

set settingHsr [ #prp := value ]