Blame docs/libnm/html/NMAccessPoint.html

Packit 5756e2
Packit 5756e2
<html>
Packit 5756e2
<head>
Packit 5756e2
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit 5756e2
<title>NMAccessPoint: libnm Reference Manual</title>
Packit 5756e2
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit 5756e2
<link rel="home" href="index.html" title="libnm Reference Manual">
Packit 5756e2
<link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference">
Packit 5756e2
<link rel="prev" href="NMVpnConnection.html" title="NMVpnConnection">
Packit 5756e2
<link rel="next" href="NMWifiP2PPeer.html" title="NMWifiP2PPeer">
Packit Service 018b0a
<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)">
Packit 5756e2
<link rel="stylesheet" href="style.css" type="text/css">
Packit 5756e2
</head>
Packit 5756e2
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit 5756e2
Packit 5756e2
Packit 5756e2
Top  | 
Packit 5756e2
                  Description
Packit 5756e2
Packit 5756e2
Home
Packit 5756e2
Up
Packit 5756e2
Prev
Packit 5756e2
Next
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

NMAccessPoint

Packit 5756e2

NMAccessPoint

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NM80211ApFlags
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_flags ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NM80211ApSecurityFlags
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_wpa_flags ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NM80211ApSecurityFlags
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_rsn_flags ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
GBytes *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_ssid ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
const char *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_bssid ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint32
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_frequency ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
NM80211Mode
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_mode ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint32
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_max_bitrate ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
guint8
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_strength ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
int
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_get_last_seen ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
GPtrArray *
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_filter_connections ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
gboolean
Packit 5756e2
Packit 5756e2
Packit 5756e2
nm_access_point_connection_valid ()
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_FLAGS
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_WPA_FLAGS
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_RSN_FLAGS
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_SSID
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_BSSID
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_FREQUENCY
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_MODE
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_MAX_BITRATE
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_STRENGTH
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_LAST_SEEN
Packit 5756e2
Packit 5756e2
Packit 5756e2
#define
Packit 5756e2
NM_ACCESS_POINT_HW_ADDRESS
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Description

Packit 5756e2
Packit 5756e2
Packit 5756e2

Functions

Packit 5756e2
Packit 5756e2

nm_access_point_get_flags ()

Packit 5756e2
NM80211ApFlags
Packit 5756e2
nm_access_point_get_flags (NMAccessPoint *ap);
Packit 5756e2

Gets the flags of the access point.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the flags

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_wpa_flags ()

Packit 5756e2
NM80211ApSecurityFlags
Packit 5756e2
nm_access_point_get_wpa_flags (NMAccessPoint *ap);
Packit 5756e2

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

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the WPA flags

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_rsn_flags ()

Packit 5756e2
NM80211ApSecurityFlags
Packit 5756e2
nm_access_point_get_rsn_flags (NMAccessPoint *ap);
Packit 5756e2

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

Packit 5756e2
point.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the RSN flags

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_ssid ()

Packit 5756e2
GBytes *
Packit 5756e2
nm_access_point_get_ssid (NMAccessPoint *ap);
Packit 5756e2

Gets the SSID of the access point.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the GBytes containing the SSID, or NULL if the

Packit 5756e2
SSID is unknown. 

Packit Service 018b0a

[transfer none]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_bssid ()

Packit 5756e2
const char *
Packit 5756e2
nm_access_point_get_bssid (NMAccessPoint *ap);
Packit 5756e2

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

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the BSSID of the access point. This is an internal string and must

Packit 5756e2
not be modified or freed.

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_frequency ()

Packit 5756e2
guint32
Packit 5756e2
nm_access_point_get_frequency (NMAccessPoint *ap);
Packit 5756e2

Gets the frequency of the access point in MHz.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the frequency in MHz

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_mode ()

Packit 5756e2
NM80211Mode
Packit 5756e2
nm_access_point_get_mode (NMAccessPoint *ap);
Packit 5756e2

Gets the mode of the access point.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the mode

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_max_bitrate ()

Packit 5756e2
guint32
Packit 5756e2
nm_access_point_get_max_bitrate (NMAccessPoint *ap);
Packit 5756e2

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

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the maximum bit rate (kbit/s)

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_strength ()

Packit 5756e2
guint8
Packit 5756e2
nm_access_point_get_strength (NMAccessPoint *ap);
Packit 5756e2

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

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the signal strength (0 to 100)

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_get_last_seen ()

Packit 5756e2
int
Packit 5756e2
nm_access_point_get_last_seen (NMAccessPoint *ap);
Packit 5756e2

Returns the timestamp (in CLOCK_BOOTTIME seconds) for the last time the

Packit 5756e2
access point was found in scan results.  A value of -1 means the access
Packit 5756e2
point has not been found in a scan.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

a NMAccessPoint

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

the last seen time in seconds

Packit 5756e2
Packit 5756e2

Since: 1.2

Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_filter_connections ()

Packit 5756e2
GPtrArray *
Packit 5756e2
nm_access_point_filter_connections (NMAccessPoint *ap,
Packit 5756e2
                                    const GPtrArray *connections);
Packit 5756e2

Filters a given array of connections for a given NMAccessPoint object and

Packit 5756e2
returns connections which may be activated with the access point.  Any
Packit 5756e2
returned connections will match the ap
Packit 5756e2
's SSID and (if given) BSSID and
Packit 5756e2
other attributes like security settings, channel, etc.

Packit 5756e2

To obtain the list of connections that are compatible with this access point,

Packit 5756e2
use nm_client_get_connections() and then filter the returned list for a given
Packit 5756e2
NMDevice using nm_device_filter_connections() and finally filter that list
Packit 5756e2
with this function.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

an NMAccessPoint to filter connections for

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

connections

Packit Service 018b0a

an array of NMConnections to

Packit 5756e2
filter. 

Packit 5756e2
[element-type NMConnection]
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

an array of

Packit Service 018b0a
NMConnections that could be activated with the given ap
Packit 5756e2
.  The array should
Packit Service 8f75d2
be freed with g_ptr_array_unref() when it is no longer required.

Packit Service 8f75d2

WARNING: the transfer annotation for this function may not work correctly

Packit Service 8f75d2
with bindings. See https://gitlab.gnome.org/GNOME/gobject-introspection/-/issues/305.
Packit Service 8f75d2
You can filter the list yourself with nm_access_point_connection_valid(). 

Packit Service 018b0a

[transfer full][element-type NMConnection]

Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

nm_access_point_connection_valid ()

Packit 5756e2
gboolean
Packit 5756e2
nm_access_point_connection_valid (NMAccessPoint *ap,
Packit 5756e2
                                  NMConnection *connection);
Packit 5756e2

Validates a given connection against a given Wi-Fi access point to ensure that

Packit 5756e2
the connection may be activated with that AP.  The connection must match the
Packit 5756e2
ap
Packit 5756e2
's SSID, (if given) BSSID, and other attributes like security settings,
Packit 5756e2
channel, band, etc.

Packit 5756e2
Packit 5756e2

Parameters

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

ap

Packit 5756e2

an NMAccessPoint to validate connection

Packit 5756e2
against

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2

connection

Packit 5756e2

an NMConnection to validate against ap

Packit 5756e2

Packit 5756e2
 
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Returns

Packit 5756e2

TRUE if the connection may be activated with this Wi-Fi AP,

Packit 5756e2
FALSE if it cannot be.

Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2

Types and Values

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_FLAGS

Packit 5756e2
#define NM_ACCESS_POINT_FLAGS       "flags"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_WPA_FLAGS

Packit 5756e2
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_RSN_FLAGS

Packit 5756e2
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_SSID

Packit 5756e2
#define NM_ACCESS_POINT_SSID        "ssid"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_BSSID

Packit 5756e2
#define NM_ACCESS_POINT_BSSID       "bssid"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_FREQUENCY

Packit 5756e2
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_MODE

Packit 5756e2
#define NM_ACCESS_POINT_MODE        "mode"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_MAX_BITRATE

Packit 5756e2
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_STRENGTH

Packit 5756e2
#define NM_ACCESS_POINT_STRENGTH    "strength"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_LAST_SEEN

Packit 5756e2
#define NM_ACCESS_POINT_LAST_SEEN   "last-seen"
Packit 5756e2
Packit 5756e2
Packit 5756e2

Packit 5756e2
Packit 5756e2

NM_ACCESS_POINT_HW_ADDRESS

Packit Service a1bd4f
#define NM_ACCESS_POINT_HW_ADDRESS "hw-address"
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit 5756e2
Packit Service 018b0a

Generated by GTK-Doc V1.33.0
Packit 5756e2
</body>
Packit 5756e2
</html>