GI.NM.Objects.DeviceWimax

No description available in the introspection data.

Exported types

newtype DeviceWimax

Memory-managed wrapper type.

Constructors

DeviceWimax (ManagedPtr DeviceWimax)

Instances

Eq DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

Methods

(==) :: DeviceWimax -> DeviceWimax -> Bool

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

GObject DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

ManagedPtrNewtype DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

Methods

toManagedPtr :: DeviceWimax -> ManagedPtr DeviceWimax

TypedObject DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

Methods

glibType :: IO GType

HasParentTypes DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

IsGValue (Maybe DeviceWimax)

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

Defined in GI.NM.Objects.DeviceWimax

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes DeviceWimax

Defined in GI.NM.Objects.DeviceWimax

type ParentTypes DeviceWimax = '[Device, Object, Object]

class (GObject o, IsDescendantOf DeviceWimax o) => IsDeviceWimax o

Type class for types which can be safely cast to DeviceWimax, for instance with toDeviceWimax.

Instances

(GObject o, IsDescendantOf DeviceWimax o) => IsDeviceWimax o

Defined in GI.NM.Objects.DeviceWimax

toDeviceWimax :: (MonadIO m, IsDeviceWimax o) => o -> m DeviceWimax

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

bindProperty, bindPropertyFull, connectionCompatible, connectionValid, delete, deleteAsync, deleteFinish, disconnect, disconnectAsync, disconnectFinish, filterConnections, forceFloating, freezeNotify, getv, isFloating, isReal, isSoftware, notify, notifyByPspec, reapply, reapplyAsync, reapplyFinish, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getActiveConnection, getActiveNsp, getAppliedConnection, getAppliedConnectionAsync, getAppliedConnectionFinish, getAutoconnect, getAvailableConnections, getBsid, getCapabilities, getCenterFrequency, getCinr, getClient, getConnectivity, getData, getDescription, getDeviceType, getDhcp4Config, getDhcp6Config, getDriver, getDriverVersion, getFirmwareMissing, getFirmwareVersion, getHwAddress, getIface, getInterfaceFlags, getIp4Config, getIp6Config, getIpIface, getLldpNeighbors, getManaged, getMetered, getMtu, getNmPluginMissing, getNspByPath, getNsps, getPath, getPhysicalPortId, getPorts, getProduct, getProperty, getQdata, getRssi, getSettingType, getState, getStateReason, getTxPower, getTypeDescription, getUdi, getVendor.

Setters

setAutoconnect, setData, setDataFull, setManaged, setProperty.

getActiveNsp

deviceWimaxGetActiveNsp

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

wimax: a DeviceWimax

-> m WimaxNsp

Returns: the access point or Nothing if none is active

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the active WimaxNsp.

getBsid

deviceWimaxGetBsid

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

self: a DeviceWimax

-> m Text

Returns: the ID of the serving Base Station, or Nothing

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the ID of the serving Base Station when the device is connected.

getCenterFrequency

deviceWimaxGetCenterFrequency

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

self: a DeviceWimax

-> m Word32

Returns: the center frequency in KHz, or 0

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the center frequency (in KHz) of the radio channel the device is using to communicate with the network when connected. Has no meaning when the device is not connected.

getCinr

deviceWimaxGetCinr

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

self: a DeviceWimax

-> m Int32

Returns: the CINR in dB, or 0

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no meaning when the device is not connected.

getHwAddress

deviceWimaxGetHwAddress

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

wimax: a DeviceWimax

-> m Text

Returns: the hardware address. This is the internal string used by the device, and must not be modified.

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the hardware (MAC) address of the DeviceWimax

getNspByPath

deviceWimaxGetNspByPath

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

wimax: a DeviceWimax

-> Text

path: the object path of the NSP

-> m WimaxNsp

Returns: the access point or Nothing if none is found.

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets a WimaxNsp by path.

getNsps

deviceWimaxGetNsps

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

wimax: a DeviceWimax

-> m [WimaxNsp]

Returns: a PtrArray containing all the scanned NMWimaxNsps. The returned array is owned by the client and should not be modified.

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets all the scanned NSPs of the DeviceWimax.

getRssi

deviceWimaxGetRssi

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

self: a DeviceWimax

-> m Int32

Returns: the RSSI in dBm, or 0

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Gets the RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the device is not connected.

getTxPower

deviceWimaxGetTxPower

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWimax a)

=> a

self: a DeviceWimax

-> m Int32

Returns: the TX power in dBm, or 0

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 dBm. Has no meaning when the device is not connected.

Properties

activeNsp

The active WimaxNsp of the device.

getDeviceWimaxActiveNsp :: (MonadIO m, IsDeviceWimax o) => o -> m (Maybe WimaxNsp)

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

get deviceWimax #activeNsp

bsid

The ID of the serving base station as received from the network. Has no meaning when the device is not connected.

getDeviceWimaxBsid :: (MonadIO m, IsDeviceWimax o) => o -> m Text

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

get deviceWimax #bsid

centerFrequency

The center frequency (in KHz) of the radio channel the device is using to communicate with the network when connected. Has no meaning when the device is not connected.

getDeviceWimaxCenterFrequency :: (MonadIO m, IsDeviceWimax o) => o -> m Word32

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

get deviceWimax #centerFrequency

cinr

CINR (Carrier to Interference + Noise Ratio) of the current radio link in dB. CINR is a more accurate measure of radio link quality. Has no meaning when the device is not connected.

getDeviceWimaxCinr :: (MonadIO m, IsDeviceWimax o) => o -> m Int32

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

get deviceWimax #cinr

hwAddress

The hardware (MAC) address of the device.

getDeviceWimaxHwAddress :: (MonadIO m, IsDeviceWimax o) => o -> m Text

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

get deviceWimax #hwAddress

nsps

rssi

RSSI of the current radio link in dBm. This value indicates how strong the raw received RF signal from the base station is, but does not indicate the overall quality of the radio link. Has no meaning when the device is not connected.

getDeviceWimaxRssi :: (MonadIO m, IsDeviceWimax o) => o -> m Int32

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

get deviceWimax #rssi

txPower

Average power of the last burst transmitted by the device, in units of 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of -5.5 dBm. Has no meaning when the device is not connected.

getDeviceWimaxTxPower :: (MonadIO m, IsDeviceWimax o) => o -> m Int32

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

get deviceWimax #txPower

Signals

nspAdded

type DeviceWimaxNspAddedCallback

Arguments

 = Object

nsp: the new NSP

-> IO ()

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Notifies that a WimaxNsp is added to the wimax device.

afterDeviceWimaxNspAdded :: (IsDeviceWimax a, MonadIO m) => a -> ((?self :: a) => DeviceWimaxNspAddedCallback) -> m SignalHandlerId

Connect a signal handler for the nspAdded signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after deviceWimax #nspAdded callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDeviceWimaxNspAdded :: (IsDeviceWimax a, MonadIO m) => a -> ((?self :: a) => DeviceWimaxNspAddedCallback) -> m SignalHandlerId

Connect a signal handler for the nspAdded signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on deviceWimax #nspAdded callback

nspRemoved

type DeviceWimaxNspRemovedCallback

Arguments

 = Object

nsp: the removed NSP

-> IO ()

Deprecated: (Since version 1.2)WiMAX is no longer supported.

Notifies that a WimaxNsp is removed from the wimax device.

afterDeviceWimaxNspRemoved :: (IsDeviceWimax a, MonadIO m) => a -> ((?self :: a) => DeviceWimaxNspRemovedCallback) -> m SignalHandlerId

Connect a signal handler for the nspRemoved signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after deviceWimax #nspRemoved callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onDeviceWimaxNspRemoved :: (IsDeviceWimax a, MonadIO m) => a -> ((?self :: a) => DeviceWimaxNspRemovedCallback) -> m SignalHandlerId

Connect a signal handler for the nspRemoved signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on deviceWimax #nspRemoved callback