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

Description

IEEE 802.15.4 (WPAN) MAC Settings

Since: 1.14

Synopsis

Exported types

newtype SettingWpan Source #

Memory-managed wrapper type.

class (GObject o, IsDescendantOf SettingWpan o) => IsSettingWpan o Source #

Type class for types which can be safely cast to SettingWpan, for instance with toSettingWpan.

Instances

Instances details
(GObject o, IsDescendantOf SettingWpan o) => IsSettingWpan o Source # 
Instance details

Defined in GI.NM.Objects.SettingWpan

toSettingWpan :: (MonadIO m, IsSettingWpan o) => o -> m SettingWpan Source #

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

Methods

getChannel

settingWpanGetChannel Source #

Arguments

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

setting: the SettingWpan

-> m Int16

Returns: the SettingWpan:channel property of the setting

No description available in the introspection data.

Since: 1.42

getMacAddress

settingWpanGetMacAddress Source #

Arguments

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

setting: the SettingWpan

-> m Text

Returns: the SettingWpan:macAddress property of the setting

No description available in the introspection data.

Since: 1.42

getPage

settingWpanGetPage Source #

Arguments

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

setting: the SettingWpan

-> m Int16

Returns: the SettingWpan:page property of the setting

No description available in the introspection data.

Since: 1.42

getPanId

settingWpanGetPanId Source #

Arguments

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

setting: the SettingWpan

-> m Word16

Returns: the SettingWpan:panId property of the setting

No description available in the introspection data.

Since: 1.42

getShortAddress

settingWpanGetShortAddress Source #

Arguments

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

setting: the SettingWpan

-> m Word16

Returns: the SettingWpan:shortAddress property of the setting

No description available in the introspection data.

Since: 1.42

new

settingWpanNew Source #

Arguments

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

Returns: the new empty SettingWpan object

Creates a new SettingWpan object with default values.

Since: 1.42

Properties

channel

IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

Since: 1.16

constructSettingWpanChannel :: (IsSettingWpan o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingWpanChannel :: (MonadIO m, IsSettingWpan o) => o -> m Int32 Source #

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

get settingWpan #channel

setSettingWpanChannel :: (MonadIO m, IsSettingWpan o) => o -> Int32 -> m () Source #

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

set settingWpan [ #channel := value ]

macAddress

If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.

clearSettingWpanMacAddress :: (MonadIO m, IsSettingWpan o) => o -> m () Source #

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

clear #macAddress

constructSettingWpanMacAddress :: (IsSettingWpan o, MonadIO m) => Text -> m (GValueConstruct o) Source #

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

getSettingWpanMacAddress :: (MonadIO m, IsSettingWpan o) => o -> m Text Source #

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

get settingWpan #macAddress

setSettingWpanMacAddress :: (MonadIO m, IsSettingWpan o) => o -> Text -> m () Source #

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

set settingWpan [ #macAddress := value ]

page

IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".

Since: 1.16

constructSettingWpanPage :: (IsSettingWpan o, MonadIO m) => Int32 -> m (GValueConstruct o) Source #

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

getSettingWpanPage :: (MonadIO m, IsSettingWpan o) => o -> m Int32 Source #

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

get settingWpan #page

setSettingWpanPage :: (MonadIO m, IsSettingWpan o) => o -> Int32 -> m () Source #

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

set settingWpan [ #page := value ]

panId

IEEE 802.15.4 Personal Area Network (PAN) identifier.

constructSettingWpanPanId :: (IsSettingWpan o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingWpanPanId :: (MonadIO m, IsSettingWpan o) => o -> m Word32 Source #

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

get settingWpan #panId

setSettingWpanPanId :: (MonadIO m, IsSettingWpan o) => o -> Word32 -> m () Source #

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

set settingWpan [ #panId := value ]

shortAddress

Short IEEE 802.15.4 address to be used within a restricted environment.

constructSettingWpanShortAddress :: (IsSettingWpan o, MonadIO m) => Word32 -> m (GValueConstruct o) Source #

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

getSettingWpanShortAddress :: (MonadIO m, IsSettingWpan o) => o -> m Word32 Source #

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

get settingWpan #shortAddress

setSettingWpanShortAddress :: (MonadIO m, IsSettingWpan o) => o -> Word32 -> m () Source #

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

set settingWpan [ #shortAddress := value ]