Struct AccessPoint 

pub struct AccessPoint { /* private fields */ }

Properties

bandwidth

The channel bandwidth announced by the AP in MHz.

Readable

bssid

The BSSID of the access point.

Readable

flags

The flags of the access point.

Readable

frequency

The frequency of the access point.

Readable

hw-address

Alias for #NMAccessPoint:bssid.

Readable

last-seen

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.

Readable

max-bitrate

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

Readable

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

Readable

rsn-flags

The RSN flags of the access point.

Readable

ssid

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

Readable

strength

The current signal strength of the access point.

Readable

wpa-flags

The WPA flags of the access point.

Readable

Object

client

The NMClient instance as returned by nm_object_get_client().

When an NMObject gets removed from the NMClient cache, the NMObject:path property stays unchanged, but this client instance gets reset to None. You can use this property to track removal of the object from the cache.

Readable

path

The D-Bus object path.

The D-Bus path of an object instance never changes, even if the object gets removed from the cache. To see whether the object is still in the cache, check NMObject:client.

Readable

Implements

ObjectExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl AccessPoint

pub fn connection_valid(&self, connection: &impl IsA<Connection>) -> bool

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 @self’s SSID, (if given) BSSID, and other attributes like security settings, channel, band, etc.

connection

an #NMConnection to validate against @self

Returns

true if the connection may be activated with this Wi-Fi AP, false if it cannot be.

pub fn filter_connections(&self, connections: &[Connection]) -> Vec<Connection>

Filters a given array of connections for a given #NMAccessPoint object and returns connections which may be activated with the access point. Any returned connections will match the @self’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 nm_client_get_connections() and then filter the returned list for a given #NMDevice using nm_device_filter_connections() and finally filter that list with this function.

connections

an array of #NMConnections to filter

Returns

an array of #NMConnections that could be activated with the given @self. 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 nm_access_point_connection_valid().

pub fn bssid(&self) -> GString

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

Returns

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

pub fn flags(&self) -> NM80211ApFlags

Gets the flags of the access point.

Returns

the flags

pub fn frequency(&self) -> u32

Gets the frequency of the access point in MHz.

Returns

the frequency in MHz

pub fn last_seen(&self) -> i32

Available on crate feature v1_2 only.

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.

Returns

the last seen time in seconds

pub fn max_bitrate(&self) -> u32

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

Returns

the maximum bit rate (kbit/s)

pub fn mode(&self) -> NM80211Mode

Gets the mode of the access point.

Returns

the mode

pub fn rsn_flags(&self) -> NM80211ApSecurityFlags

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

Returns

the RSN flags

pub fn strength(&self) -> u8

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

Returns

the signal strength (0 to 100)

pub fn wpa_flags(&self) -> NM80211ApSecurityFlags

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

Returns

the WPA flags

pub fn connect_bssid_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_frequency_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_last_seen_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Available on crate feature v1_2 only.

pub fn connect_max_bitrate_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_mode_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_rsn_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_ssid_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_strength_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_wpa_flags_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for AccessPoint

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AccessPoint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for AccessPoint

type ParamSpec = ParamSpecObject

type SetValue = AccessPoint

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, AccessPoint>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AccessPoint

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AccessPoint

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for AccessPoint

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for AccessPoint

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for AccessPoint

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for AccessPoint

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AccessPoint

impl IsA<Object> for AccessPoint