From 2c032d8f1c6292c1338a615e6ec40252889ba85c Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 22 Jan 2015 00:29:39 +0100 Subject: Imported Upstream version 1.0.0 --- docs/libnm/html/NMAccessPoint.html | 613 +++++++++++++++++++++++++++++++++++++ 1 file changed, 613 insertions(+) create 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 new file mode 100644 index 00000000..9b21cae9 --- /dev/null +++ b/docs/libnm/html/NMAccessPoint.html @@ -0,0 +1,613 @@ + + + + +NMAccessPoint + + + + + + + + + + + + + + + + + + + +
+
+
+ + +
+

NMAccessPoint

+

NMAccessPoint

+
+
+

Synopsis

+
#define             NM_ACCESS_POINT_FLAGS
+#define             NM_ACCESS_POINT_WPA_FLAGS
+#define             NM_ACCESS_POINT_RSN_FLAGS
+#define             NM_ACCESS_POINT_SSID
+#define             NM_ACCESS_POINT_BSSID
+#define             NM_ACCESS_POINT_FREQUENCY
+#define             NM_ACCESS_POINT_MODE
+#define             NM_ACCESS_POINT_MAX_BITRATE
+#define             NM_ACCESS_POINT_STRENGTH
+#define             NM_ACCESS_POINT_HW_ADDRESS
+struct              NMAccessPoint;
+                    NMAccessPointClass;
+NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+NM80211ApSecurityFlags nm_access_point_get_wpa_flags    (NMAccessPoint *ap);
+NM80211ApSecurityFlags nm_access_point_get_rsn_flags    (NMAccessPoint *ap);
+GBytes *            nm_access_point_get_ssid            (NMAccessPoint *ap);
+const char *        nm_access_point_get_bssid           (NMAccessPoint *ap);
+guint32             nm_access_point_get_frequency       (NMAccessPoint *ap);
+NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
+guint32             nm_access_point_get_max_bitrate     (NMAccessPoint *ap);
+guint8              nm_access_point_get_strength        (NMAccessPoint *ap);
+GPtrArray *         nm_access_point_filter_connections  (NMAccessPoint *ap,
+                                                         const GPtrArray *connections);
+gboolean            nm_access_point_connection_valid    (NMAccessPoint *ap,
+                                                         NMConnection *connection);
+
+
+
+

Object Hierarchy

+
+  GObject
+   +----NMObject
+         +----NMAccessPoint
+
+
+
+

Implemented Interfaces

+

+NMAccessPoint implements + GInitable and GAsyncInitable.

+
+
+

Properties

+
+  "bssid"                    gchar*                : Read
+  "flags"                    NM80211ApFlags        : Read
+  "frequency"                guint                 : Read
+  "hw-address"               gchar*                : Read
+  "max-bitrate"              guint                 : Read
+  "mode"                     NM80211Mode           : Read
+  "rsn-flags"                NM80211ApSecurityFlags  : Read
+  "ssid"                     GBytes*               : Read
+  "strength"                 guchar                : Read
+  "wpa-flags"                NM80211ApSecurityFlags  : Read
+
+
+
+

Description

+

+

+
+
+

Details

+
+

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_HW_ADDRESS

+
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+
+

+

+
+
+
+

struct NMAccessPoint

+
struct NMAccessPoint;
+

+

+
+
+
+

NMAccessPointClass

+
typedef struct {
+	NMObjectClass parent;
+} NMAccessPointClass;
+
+

+

+
+
+
+

nm_access_point_get_flags ()

+
NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
+

+Gets the flags of the access point. +

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the frequency
+
+
+
+

nm_access_point_get_mode ()

+
NM80211Mode         nm_access_point_get_mode            (NMAccessPoint *ap);
+

+Gets the mode of the access point. +

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

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

+
++++ + + + + + + + + + + +

ap :

a NMAccessPoint +

Returns :

the signal strength
+
+
+
+

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

+
++++ + + + + + + + + + + + + + + +

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. [transfer container][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. +

+
++++ + + + + + + + + + + + + + + +

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

Property Details

+
+

The "bssid" property

+
  "bssid"                    gchar*                : Read
+

+The BSSID of the access point. +

+

Default value: NULL

+
+
+
+

The "flags" property

+
  "flags"                    NM80211ApFlags        : Read
+

+The flags of the access point. +

+
+
+
+

The "frequency" property

+
  "frequency"                guint                 : Read
+

+The frequency of the access point. +

+

Allowed values: <= 10000

+

Default value: 0

+
+
+
+

The "hw-address" property

+
  "hw-address"               gchar*                : Read
+
+

Warning

+

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

+
+

+Alias for "bssid". +

+

Default value: NULL

+
+
+
+

The "max-bitrate" property

+
  "max-bitrate"              guint                 : Read
+

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

+

Default value: 0

+
+
+
+

The "mode" property

+
  "mode"                     NM80211Mode           : Read
+

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

+

Default value: NM_802_11_MODE_INFRA

+
+
+
+

The "rsn-flags" property

+
  "rsn-flags"                NM80211ApSecurityFlags  : Read
+

+The RSN flags of the access point. +

+
+
+
+

The "ssid" property

+
  "ssid"                     GBytes*               : Read
+

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

+
+
+
+

The "strength" property

+
  "strength"                 guchar                : Read
+

+The current signal strength of the access point. +

+

Default value: 0

+
+
+
+

The "wpa-flags" property

+
  "wpa-flags"                NM80211ApSecurityFlags  : Read
+

+The WPA flags of the access point. +

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