From e465722b908aa870bdc293b9a417d3c15294aa6d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 25 Dec 2024 20:36:29 +0100 Subject: New upstream version 1.50.1 --- docs/libnm/html/NMAccessPoint.html | 886 ------------------------------------- 1 file changed, 886 deletions(-) delete mode 100644 docs/libnm/html/NMAccessPoint.html (limited to 'docs/libnm/html/NMAccessPoint.html') diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html deleted file mode 100644 index e02c98e1..00000000 --- a/docs/libnm/html/NMAccessPoint.html +++ /dev/null @@ -1,886 +0,0 @@ - - - - -NMAccessPoint: libnm Reference Manual - - - - - - - - - - - - - - - - -
-
-
- - -
-

NMAccessPoint

-

NMAccessPoint

-
-
-

Functions

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

Properties

-
----- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
guintbandwidthRead
-char *bssidRead
NM80211ApFlagsflagsRead
guintfrequencyRead
-char *hw-addressRead
intlast-seenRead
guintmax-bitrateRead
NM80211ModemodeRead
NM80211ApSecurityFlagsrsn-flagsRead
-GBytes *ssidRead
gucharstrengthRead
NM80211ApSecurityFlagswpa-flagsRead
-
-
-

Types and Values

-
---- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#defineNM_ACCESS_POINT_FLAGS
#defineNM_ACCESS_POINT_WPA_FLAGS
#defineNM_ACCESS_POINT_RSN_FLAGS
#defineNM_ACCESS_POINT_SSID
#defineNM_ACCESS_POINT_BSSID
#defineNM_ACCESS_POINT_FREQUENCY
#defineNM_ACCESS_POINT_MODE
#defineNM_ACCESS_POINT_MAX_BITRATE
#defineNM_ACCESS_POINT_STRENGTH
#defineNM_ACCESS_POINT_LAST_SEEN
#defineNM_ACCESS_POINT_BANDWIDTH
#defineNM_ACCESS_POINT_HW_ADDRESS
 NMAccessPoint
-
-
-

Object Hierarchy

-
    GObject
-    ╰── NMObject
-        ╰── NMAccessPoint
-
-
-
-

Description

-
-
-

Functions

-
-

nm_access_point_get_flags ()

-
NM80211ApFlags
-nm_access_point_get_flags (NMAccessPoint *ap);
-

Gets the flags of the access point.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the flags

-
-
-
-
-

nm_access_point_get_wpa_flags ()

-
NM80211ApSecurityFlags
-nm_access_point_get_wpa_flags (NMAccessPoint *ap);
-

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

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the WPA flags

-
-
-
-
-

nm_access_point_get_rsn_flags ()

-
NM80211ApSecurityFlags
-nm_access_point_get_rsn_flags (NMAccessPoint *ap);
-

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

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the RSN flags

-
-
-
-
-

nm_access_point_get_ssid ()

-
GBytes *
-nm_access_point_get_ssid (NMAccessPoint *ap);
-

Gets the SSID of the access point.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the GBytes containing the SSID, or NULL if the -SSID is unknown.

-

[transfer none]

-
-
-
-
-

nm_access_point_get_bssid ()

-
const char *
-nm_access_point_get_bssid (NMAccessPoint *ap);
-

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

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

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

-
-
-
-
-

nm_access_point_get_frequency ()

-
guint32
-nm_access_point_get_frequency (NMAccessPoint *ap);
-

Gets the frequency of the access point in MHz.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the frequency in MHz

-
-
-
-
-

nm_access_point_get_mode ()

-
NM80211Mode
-nm_access_point_get_mode (NMAccessPoint *ap);
-

Gets the mode of the access point.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the mode

-
-
-
-
-

nm_access_point_get_max_bitrate ()

-
guint32
-nm_access_point_get_max_bitrate (NMAccessPoint *ap);
-

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

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the maximum bit rate (kbit/s)

-
-
-
-
-

nm_access_point_get_strength ()

-
guint8
-nm_access_point_get_strength (NMAccessPoint *ap);
-

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

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the signal strength (0 to 100)

-
-
-
-
-

nm_access_point_get_last_seen ()

-
int
-nm_access_point_get_last_seen (NMAccessPoint *ap);
-

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.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the last seen time in seconds

-
-

Since: 1.2

-
-
-
-

nm_access_point_get_bandwidth ()

-
guint32
-nm_access_point_get_bandwidth (NMAccessPoint *ap);
-

Gets the bandwidth advertised by the access point in MHz.

-
-

Parameters

-
----- - - - - - -

ap

a NMAccessPoint

 
-
-
-

Returns

-

the advertised bandwidth (MHz)

-
-

Since: 1.46

-
-
-
-

nm_access_point_filter_connections ()

-
GPtrArray *
-nm_access_point_filter_connections (NMAccessPoint *ap,
-                                    const GPtrArray *connections);
-

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

-
-

Parameters

-
----- - - - - - - - - - - - - -

ap

an NMAccessPoint to filter connections for

 

connections

an array of NMConnections to -filter.

[element-type NMConnection]
-
-
-

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

-

[transfer full][element-type NMConnection]

-
-
-
-
-

nm_access_point_connection_valid ()

-
gboolean
-nm_access_point_connection_valid (NMAccessPoint *ap,
-                                  NMConnection *connection);
-

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.

-
-

Parameters

-
----- - - - - - - - - - - - - -

ap

an NMAccessPoint to validate connection -against

 

connection

an NMConnection to validate against ap -

 
-
-
-

Returns

-

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

-
-
-
-
-

Types and Values

-
-

NM_ACCESS_POINT_FLAGS

-
#define NM_ACCESS_POINT_FLAGS       "flags"
-
-
-
-
-

NM_ACCESS_POINT_WPA_FLAGS

-
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
-
-
-
-
-

NM_ACCESS_POINT_RSN_FLAGS

-
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
-
-
-
-
-

NM_ACCESS_POINT_SSID

-
#define NM_ACCESS_POINT_SSID        "ssid"
-
-
-
-
-

NM_ACCESS_POINT_BSSID

-
#define NM_ACCESS_POINT_BSSID       "bssid"
-
-
-
-
-

NM_ACCESS_POINT_FREQUENCY

-
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
-
-
-
-
-

NM_ACCESS_POINT_MODE

-
#define NM_ACCESS_POINT_MODE        "mode"
-
-
-
-
-

NM_ACCESS_POINT_MAX_BITRATE

-
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
-
-
-
-
-

NM_ACCESS_POINT_STRENGTH

-
#define NM_ACCESS_POINT_STRENGTH    "strength"
-
-
-
-
-

NM_ACCESS_POINT_LAST_SEEN

-
#define NM_ACCESS_POINT_LAST_SEEN   "last-seen"
-
-
-
-
-

NM_ACCESS_POINT_BANDWIDTH

-
#define NM_ACCESS_POINT_BANDWIDTH   "bandwidth"
-
-
-
-
-

NM_ACCESS_POINT_HW_ADDRESS

-
#define NM_ACCESS_POINT_HW_ADDRESS "hw-address"
-
-
-
-
-

NMAccessPoint

-
typedef struct _NMAccessPoint NMAccessPoint;
-
-
-
-

Property Details

-
-

The “bandwidth” property

-
  “bandwidth”                guint
-

The channel bandwidth announced by the AP in MHz.

-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: 0

-

Since: 1.46

-
-
-
-

The “bssid” property

-
  “bssid”                    char *
-

The BSSID of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: NULL

-
-
-
-

The “flags” property

-
  “flags”                    NM80211ApFlags
-

The flags of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-
-
-
-

The “frequency” property

-
  “frequency”                guint
-

The frequency of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-

Allowed values: <= 10000

-

Default value: 0

-
-
-
-

The “hw-address” property

-
  “hw-address”               char *
-

Alias for “bssid”.

-
-

NMAccessPoint:hw-address has been deprecated since version 1.0 and should not be used in newly-written code.

-

Use “bssid”.

-
-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: NULL

-
-
-
-

The “last-seen” property

-
  “last-seen”                int
-

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.

-

Owner: NMAccessPoint

-

Flags: Read

-

Allowed values: >= -1

-

Default value: -1

-

Since: 1.2

-
-
-
-

The “max-bitrate” property

-
  “max-bitrate”              guint
-

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

-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: 0

-
-
-
-

The “mode” property

-
  “mode”                     NM80211Mode
-

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

-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: NM_802_11_MODE_UNKNOWN

-
-
-
-

The “rsn-flags” property

-
  “rsn-flags”                NM80211ApSecurityFlags
-

The RSN flags of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-
-
-
-

The “ssid” property

-
  “ssid”                     GBytes *
-

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

-

Owner: NMAccessPoint

-

Flags: Read

-
-
-
-

The “strength” property

-
  “strength”                 guchar
-

The current signal strength of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-

Default value: 0

-
-
-
-

The “wpa-flags” property

-
  “wpa-flags”                NM80211ApSecurityFlags
-

The WPA flags of the access point.

-

Owner: NMAccessPoint

-

Flags: Read

-
-
-
-
-
Generated by GTK-Doc V1.34.0
- - \ No newline at end of file -- cgit 1.3.0-6-gf8a5