GI.NM.Objects.AccessPoint

No description available in the introspection data.

Exported types

newtype AccessPoint

Memory-managed wrapper type.

Constructors

AccessPoint (ManagedPtr AccessPoint)

Instances

Eq AccessPoint

Defined in GI.NM.Objects.AccessPoint

Methods

(==) :: AccessPoint -> AccessPoint -> Bool

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

GObject AccessPoint

Defined in GI.NM.Objects.AccessPoint

ManagedPtrNewtype AccessPoint

Defined in GI.NM.Objects.AccessPoint

Methods

toManagedPtr :: AccessPoint -> ManagedPtr AccessPoint

TypedObject AccessPoint

Defined in GI.NM.Objects.AccessPoint

Methods

glibType :: IO GType

HasParentTypes AccessPoint

Defined in GI.NM.Objects.AccessPoint

IsGValue (Maybe AccessPoint)

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

Defined in GI.NM.Objects.AccessPoint

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes AccessPoint

Defined in GI.NM.Objects.AccessPoint

type ParentTypes AccessPoint = '[Object, Object]

class (GObject o, IsDescendantOf AccessPoint o) => IsAccessPoint o

Type class for types which can be safely cast to AccessPoint, for instance with toAccessPoint.

Instances

(GObject o, IsDescendantOf AccessPoint o) => IsAccessPoint o

Defined in GI.NM.Objects.AccessPoint

toAccessPoint :: (MonadIO m, IsAccessPoint o) => o -> m AccessPoint

Cast to AccessPoint, 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, connectionValid, filterConnections, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getBandwidth, getBssid, getClient, getData, getFlags, getFrequency, getLastSeen, getMaxBitrate, getMode, getPath, getProperty, getQdata, getRsnFlags, getSsid, getStrength, getWpaFlags.

Setters

setData, setDataFull, setProperty.

connectionValid

accessPointConnectionValid

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a, IsConnection b)

=> a

ap: an AccessPoint to validate connection against

-> b

connection: an Connection to validate against ap

-> m Bool

Returns: True if the connection may be activated with this Wi-Fi AP, False if it cannot be.

Validates a given connection against a given Wi-Fi access point to ensure that the connection may be activated with that AP. The connection must match the ap's SSID, (if given) BSSID, and other attributes like security settings, channel, band, etc.

filterConnections

accessPointFilterConnections

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: an AccessPoint to filter connections for

-> [Connection]

connections: an array of NMConnections to filter

-> m [Connection]

Returns: an array of NMConnections that could be activated with the given ap. The array should be freed with g_ptr_array_unref() when it is no longer required.

WARNING: the transfer annotation for this function may not work correctly with bindings. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/305. You can filter the list yourself with accessPointConnectionValid.

Filters a given array of connections for a given AccessPoint object and returns connections which may be activated with the access point. Any returned connections will match the ap's SSID and (if given) BSSID and other attributes like security settings, channel, etc.

To obtain the list of connections that are compatible with this access point, use clientGetConnections and then filter the returned list for a given Device using deviceFilterConnections and finally filter that list with this function.

getBandwidth

accessPointGetBandwidth

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Word32

Returns: the advertised bandwidth (MHz)

Gets the bandwidth advertised by the access point in MHz.

Since: 1.46

getBssid

accessPointGetBssid

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Text

Returns: the BSSID of the access point. This is an internal string and must not be modified or freed.

Gets the Basic Service Set ID (BSSID) of the Wi-Fi access point.

getFlags

accessPointGetFlags

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m [NM80211ApFlags]

Returns: the flags

Gets the flags of the access point.

getFrequency

accessPointGetFrequency

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Word32

Returns: the frequency in MHz

Gets the frequency of the access point in MHz.

getLastSeen

accessPointGetLastSeen

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Int32

Returns: the last seen time in seconds

Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access point has not been found in a scan.

Since: 1.2

getMaxBitrate

accessPointGetMaxBitrate

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Word32

Returns: the maximum bit rate (kbit/s)

Gets the maximum bit rate of the access point in kbit/s.

getMode

accessPointGetMode

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m NM80211Mode

Returns: the mode

Gets the mode of the access point.

getRsnFlags

accessPointGetRsnFlags

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m [NM80211ApSecurityFlags]

Returns: the RSN flags

Gets the RSN (Robust Secure Network, ie WPA version 2) flags of the access point.

getSsid

accessPointGetSsid

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Bytes

Returns: the Bytes containing the SSID, or Nothing if the SSID is unknown.

Gets the SSID of the access point.

getStrength

accessPointGetStrength

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m Word8

Returns: the signal strength (0 to 100)

Gets the current signal strength of the access point as a percentage.

getWpaFlags

accessPointGetWpaFlags

Arguments

:: (HasCallStack, MonadIO m, IsAccessPoint a)

=> a

ap: a AccessPoint

-> m [NM80211ApSecurityFlags]

Returns: the WPA flags

Gets the WPA (version 1) flags of the access point.

Properties

bandwidth

The channel bandwidth announced by the AP in MHz.

Since: 1.46

getAccessPointBandwidth :: (MonadIO m, IsAccessPoint o) => o -> m Word32

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

get accessPoint #bandwidth

bssid

The BSSID of the access point.

getAccessPointBssid :: (MonadIO m, IsAccessPoint o) => o -> m Text

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

get accessPoint #bssid

flags

The flags of the access point.

getAccessPointFlags :: (MonadIO m, IsAccessPoint o) => o -> m [NM80211ApFlags]

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

get accessPoint #flags

frequency

The frequency of the access point.

getAccessPointFrequency :: (MonadIO m, IsAccessPoint o) => o -> m Word32

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

get accessPoint #frequency

hwAddress

Alias for AccessPoint:bssid.

getAccessPointHwAddress :: (MonadIO m, IsAccessPoint o) => o -> m (Maybe Text)

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

get accessPoint #hwAddress

lastSeen

The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access point was found in scan results. A value of -1 means the access point has not been found in a scan.

Since: 1.2

getAccessPointLastSeen :: (MonadIO m, IsAccessPoint o) => o -> m Int32

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

get accessPoint #lastSeen

maxBitrate

The maximum bit rate of the access point in kbit/s.

getAccessPointMaxBitrate :: (MonadIO m, IsAccessPoint o) => o -> m Word32

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

get accessPoint #maxBitrate

mode

The mode of the access point; either "infrastructure" (a central coordinator of the wireless network allowing clients to connect) or "ad-hoc" (a network with no central controller).

getAccessPointMode :: (MonadIO m, IsAccessPoint o) => o -> m NM80211Mode

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

get accessPoint #mode

rsnFlags

The RSN flags of the access point.

getAccessPointRsnFlags :: (MonadIO m, IsAccessPoint o) => o -> m [NM80211ApSecurityFlags]

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

get accessPoint #rsnFlags

ssid

The SSID of the access point, or Nothing if it is not known.

getAccessPointSsid :: (MonadIO m, IsAccessPoint o) => o -> m Bytes

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

get accessPoint #ssid

strength

wpaFlags

The WPA flags of the access point.

getAccessPointWpaFlags :: (MonadIO m, IsAccessPoint o) => o -> m [NM80211ApSecurityFlags]

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

get accessPoint #wpaFlags