GI.NM.Objects.DeviceWifi

No description available in the introspection data.

Exported types

newtype DeviceWifi

Memory-managed wrapper type.

Constructors

DeviceWifi (ManagedPtr DeviceWifi)

Instances

Eq DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

Methods

(==) :: DeviceWifi -> DeviceWifi -> Bool

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

GObject DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

ManagedPtrNewtype DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

Methods

toManagedPtr :: DeviceWifi -> ManagedPtr DeviceWifi

TypedObject DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

Methods

glibType :: IO GType

HasParentTypes DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

IsGValue (Maybe DeviceWifi)

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

Defined in GI.NM.Objects.DeviceWifi

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes DeviceWifi

Defined in GI.NM.Objects.DeviceWifi

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

class (GObject o, IsDescendantOf DeviceWifi o) => IsDeviceWifi o

Type class for types which can be safely cast to DeviceWifi, for instance with toDeviceWifi.

Instances

(GObject o, IsDescendantOf DeviceWifi o) => IsDeviceWifi o

Defined in GI.NM.Objects.DeviceWifi

toDeviceWifi :: (MonadIO m, IsDeviceWifi o) => o -> m DeviceWifi

Cast to DeviceWifi, 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, requestScan, requestScanAsync, requestScanFinish, requestScanOptions, requestScanOptionsAsync, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getAccessPointByPath, getAccessPoints, getActiveAccessPoint, getActiveConnection, getAppliedConnection, getAppliedConnectionAsync, getAppliedConnectionFinish, getAutoconnect, getAvailableConnections, getBitrate, getCapabilities, getClient, getConnectivity, getData, getDescription, getDeviceType, getDhcp4Config, getDhcp6Config, getDriver, getDriverVersion, getFirmwareMissing, getFirmwareVersion, getHwAddress, getIface, getInterfaceFlags, getIp4Config, getIp6Config, getIpIface, getLastScan, getLldpNeighbors, getManaged, getMetered, getMode, getMtu, getNmPluginMissing, getPath, getPermanentHwAddress, getPhysicalPortId, getPorts, getProduct, getProperty, getQdata, getSettingType, getState, getStateReason, getTypeDescription, getUdi, getVendor.

Setters

setAutoconnect, setData, setDataFull, setManaged, setProperty.

getAccessPointByPath

deviceWifiGetAccessPointByPath

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> Text

path: the object path of the access point

-> m AccessPoint

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

Gets a AccessPoint by path.

getAccessPoints

deviceWifiGetAccessPoints

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m [AccessPoint]

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

Gets all the scanned access points of the DeviceWifi.

getActiveAccessPoint

deviceWifiGetActiveAccessPoint

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m AccessPoint

Returns: the access point or Nothing if none is active

Gets the active AccessPoint.

getBitrate

deviceWifiGetBitrate

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m Word32

Returns: the bit rate (kbit/s)

Gets the bit rate of the DeviceWifi in kbit/s.

getCapabilities

deviceWifiGetCapabilities

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m [DeviceWifiCapabilities]

Returns: the capabilities

Gets the Wi-Fi capabilities of the DeviceWifi.

getLastScan

deviceWifiGetLastScan

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m Int64

Returns: the last scan time in milliseconds (in clock_gettime(CLOCK_BOOTTIME) scale).

Returns the timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan. A value of -1 means the device never scanned for access points.

Use utilsGetTimestampMsec to obtain current time value suitable for comparing to this value.

Since: 1.12

getMode

deviceWifiGetMode

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m NM80211Mode

Returns: the mode

Gets the DeviceWifi mode.

getPermanentHwAddress

deviceWifiGetPermanentHwAddress

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a)

=> a

device: a DeviceWifi

-> m Text

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

Gets the permanent hardware (MAC) address of the DeviceWifi

requestScan

deviceWifiRequestScan

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a, IsCancellable b)

=> a

device: a DeviceWifi

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Deprecated: (Since version 1.22)Use deviceWifiRequestScanAsync or GDBusConnection.

Request NM to scan for access points on device. Note that the function returns immediately after requesting the scan, and it may take some time after that for the scan to complete.

requestScanAsync

deviceWifiRequestScanAsync

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a, IsCancellable b)

=> a

device: a DeviceWifi

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the scan has been requested

-> m ()

Request NM to scan for access points on device. Note that callback will be called immediately after requesting the scan, and it may take some time after that for the scan to complete.

requestScanFinish

deviceWifiRequestScanFinish

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a, IsAsyncResult b)

=> a

device: a DeviceWifi

-> b

result: the result passed to the AsyncReadyCallback

-> m ()

(Can throw GError)

Gets the result of a call to deviceWifiRequestScanAsync and deviceWifiRequestScanOptionsAsync.

requestScanOptions

deviceWifiRequestScanOptions

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a, IsCancellable b)

=> a

device: a DeviceWifi

-> GVariant

options: dictionary with options for RequestScan(), or Nothing

-> Maybe b

cancellable: a Cancellable, or Nothing

-> m ()

(Can throw GError)

Deprecated: (Since version 1.22)Use deviceWifiRequestScanOptionsAsync or GDBusConnection.

Request NM to scan for access points on device. Note that the function returns immediately after requesting the scan, and it may take some time after that for the scan to complete. This is the same as nmDeviceWifiRequestScan except it accepts options for the scanning. The argument is the dictionary passed to RequestScan() D-Bus call. Valid options inside the dictionary are: 'ssids' => array of SSIDs (saay)

Since: 1.2

requestScanOptionsAsync

deviceWifiRequestScanOptionsAsync

Arguments

:: (HasCallStack, MonadIO m, IsDeviceWifi a, IsCancellable b)

=> a

device: a DeviceWifi

-> GVariant

options: dictionary with options for RequestScan(), or Nothing

-> Maybe b

cancellable: a Cancellable, or Nothing

-> Maybe AsyncReadyCallback

callback: callback to be called when the scan has been requested

-> m ()

Request NM to scan for access points on device. Note that callback will be called immediately after requesting the scan, and it may take some time after that for the scan to complete. This is the same as nmDeviceWifiRequestScanAsync except it accepts options for the scanning. The argument is the dictionary passed to RequestScan() D-Bus call. Valid options inside the dictionary are: 'ssids' => array of SSIDs (saay)

To complete the request call deviceWifiRequestScanFinish.

Since: 1.2

Properties

accessPoints

activeAccessPoint

The active AccessPoint of the device.

getDeviceWifiActiveAccessPoint :: (MonadIO m, IsDeviceWifi o) => o -> m AccessPoint

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

get deviceWifi #activeAccessPoint

bitrate

The bit rate of the device in kbit/s.

getDeviceWifiBitrate :: (MonadIO m, IsDeviceWifi o) => o -> m Word32

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

get deviceWifi #bitrate

lastScan

The timestamp (in CLOCK_BOOTTIME seconds) for the last finished network scan. A value of -1 means the device never scanned for access points.

Since: 1.12

getDeviceWifiLastScan :: (MonadIO m, IsDeviceWifi o) => o -> m Int64

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

get deviceWifi #lastScan

mode

The mode of the device.

getDeviceWifiMode :: (MonadIO m, IsDeviceWifi o) => o -> m NM80211Mode

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

get deviceWifi #mode

permHwAddress

The hardware (MAC) address of the device.

getDeviceWifiPermHwAddress :: (MonadIO m, IsDeviceWifi o) => o -> m (Maybe Text)

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

get deviceWifi #permHwAddress

wirelessCapabilities

The wireless capabilities of the device.

getDeviceWifiWirelessCapabilities :: (MonadIO m, IsDeviceWifi o) => o -> m [DeviceWifiCapabilities]

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

get deviceWifi #wirelessCapabilities

Signals

accessPointAdded

type DeviceWifiAccessPointAddedCallback

Arguments

 = Object

ap: the new access point

-> IO ()

Notifies that a AccessPoint is added to the Wi-Fi device.

afterDeviceWifiAccessPointAdded :: (IsDeviceWifi a, MonadIO m) => a -> ((?self :: a) => DeviceWifiAccessPointAddedCallback) -> m SignalHandlerId

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

after deviceWifi #accessPointAdded 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.

onDeviceWifiAccessPointAdded :: (IsDeviceWifi a, MonadIO m) => a -> ((?self :: a) => DeviceWifiAccessPointAddedCallback) -> m SignalHandlerId

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

on deviceWifi #accessPointAdded callback

accessPointRemoved

type DeviceWifiAccessPointRemovedCallback

Arguments

 = Object

ap: the removed access point

-> IO ()

Notifies that a AccessPoint is removed from the Wi-Fi device.

afterDeviceWifiAccessPointRemoved :: (IsDeviceWifi a, MonadIO m) => a -> ((?self :: a) => DeviceWifiAccessPointRemovedCallback) -> m SignalHandlerId

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

after deviceWifi #accessPointRemoved 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.

onDeviceWifiAccessPointRemoved :: (IsDeviceWifi a, MonadIO m) => a -> ((?self :: a) => DeviceWifiAccessPointRemovedCallback) -> m SignalHandlerId

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

on deviceWifi #accessPointRemoved callback