From f408e27bccfacf347605a8d98649975a68f38a17 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 5 May 2015 17:48:57 +0200 Subject: Imported Upstream version 1.0.2 --- docs/libnm/html/NMAccessPoint.html | 1026 +++++++++++++++++++++--------------- 1 file changed, 591 insertions(+), 435 deletions(-) (limited to 'docs/libnm/html/NMAccessPoint.html') diff --git a/docs/libnm/html/NMAccessPoint.html b/docs/libnm/html/NMAccessPoint.html index 9b21cae9..8391ef44 100644 --- a/docs/libnm/html/NMAccessPoint.html +++ b/docs/libnm/html/NMAccessPoint.html @@ -2,36 +2,28 @@ -NMAccessPoint +libnm Reference Manual: NMAccessPoint - + - - - - - - - - - - + + + + + + +
@@ -39,64 +31,227 @@

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

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 () +
+GPtrArray * + +nm_access_point_filter_connections () +
+gboolean + +nm_access_point_connection_valid () +
-

Object Hierarchy

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

Properties

+
+++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+gchar *bssidRead
NM80211ApFlagsflagsRead
guintfrequencyRead
+gchar *hw-addressRead
guintmax-bitrateRead
NM80211ModemodeRead
NM80211ApSecurityFlagsrsn-flagsRead
+GBytes *ssidRead
gucharstrengthRead
NM80211ApSecurityFlagswpa-flagsRead
-

Implemented Interfaces

-

-NMAccessPoint implements - GInitable and GAsyncInitable.

+

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

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
+
Object Hierarchy

+
    GObject
+    ╰── NMObject
+        ╰── NMAccessPoint
@@ -105,509 +260,510 @@ NMAccessPoint implements

-

Details

-
-

NM_ACCESS_POINT_FLAGS

-
#define NM_ACCESS_POINT_FLAGS       "flags"
-
-

-

+

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

 
-
-
-

NM_ACCESS_POINT_WPA_FLAGS

-
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
-
-

-

+
+

Returns

+

the 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_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

 
-
-
-

NM_ACCESS_POINT_BSSID

-
#define NM_ACCESS_POINT_BSSID       "bssid"
-
-

-

+
+

Returns

+

the WPA flags

+

-
-
-

NM_ACCESS_POINT_FREQUENCY

-
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
-
-

-

-

NM_ACCESS_POINT_MODE

-
#define NM_ACCESS_POINT_MODE        "mode"
-
-

-

+

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_MAX_BITRATE

-
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
-
-

-

+

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_STRENGTH

-
#define NM_ACCESS_POINT_STRENGTH    "strength"
-
-

-

+

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_HW_ADDRESS

-
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
-
-

-

+

nm_access_point_get_frequency ()

+
guint32
+nm_access_point_get_frequency (NMAccessPoint *ap);
+

Gets the frequency of the access point.

+
+

Parameters

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

ap

a NMAccessPoint

 
+
+
+

Returns

+

the frequency

+

+
-

struct NMAccessPoint

-
struct NMAccessPoint;
-

-

+

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

+

+
-

NMAccessPointClass

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

-

+

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_flags ()

-
NM80211ApFlags      nm_access_point_get_flags           (NMAccessPoint *ap);
-

-Gets the flags of the access point. -

-
+

nm_access_point_get_strength ()

+
guint8
+nm_access_point_get_strength (NMAccessPoint *ap);
+

Gets the current signal strength of the access point.

+
+

Parameters

+
--+++ - - - - - - - - - - + + + + +

ap :

a NMAccessPoint -

Returns :

the flags

ap

a NMAccessPoint

 
+
+

Returns

+

the signal strength

+

+
+
-

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

-
+

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 :

a NMAccessPoint -

ap

an NMAccessPoint to filter connections for

 

Returns :

the WPA flags

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

-
+

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 :

a NMAccessPoint -

ap

an NMAccessPoint to validate connection +against

 

Returns :

the RSN flags

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_get_ssid ()

-
GBytes *            nm_access_point_get_ssid            (NMAccessPoint *ap);
+

NM_ACCESS_POINT_WPA_FLAGS

+
#define NM_ACCESS_POINT_WPA_FLAGS   "wpa-flags"
+

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

NM_ACCESS_POINT_RSN_FLAGS

+
#define NM_ACCESS_POINT_RSN_FLAGS   "rsn-flags"
+

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

NM_ACCESS_POINT_SSID

+
#define NM_ACCESS_POINT_SSID        "ssid"
+

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

NM_ACCESS_POINT_BSSID

+
#define NM_ACCESS_POINT_BSSID       "bssid"
+

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

NM_ACCESS_POINT_FREQUENCY

+
#define NM_ACCESS_POINT_FREQUENCY   "frequency"
+

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

NM_ACCESS_POINT_MODE

+
#define NM_ACCESS_POINT_MODE        "mode"
+

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

NM_ACCESS_POINT_MAX_BITRATE

+
#define NM_ACCESS_POINT_MAX_BITRATE "max-bitrate"
+

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

+
+
+
+

NM_ACCESS_POINT_STRENGTH

+
#define NM_ACCESS_POINT_STRENGTH    "strength"
+

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

NM_ACCESS_POINT_HW_ADDRESS

+
#define NM_ACCESS_POINT_HW_ADDRESS  "hw-address"
+

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

+

The “bssid” property

+
  “bssid”                    gchar *
+

+

Flags: Read

Default value: NULL

-

The "flags" property

-
  "flags"                    NM80211ApFlags        : Read
-

-The flags of the access point. -

+

The “flags” property

+
  “flags”                    NM80211ApFlags
+

+

Flags: Read

-

The "frequency" property

-
  "frequency"                guint                 : Read
-

-The frequency of the access point. -

+

The “frequency” property

+
  “frequency”                guint
+

+

Flags: Read

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

+

The “hw-address” property

+
  “hw-address”               gchar *
+

+
+

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

+

use “bssid”.

-

-Alias for "bssid". -

+

Flags: Read

Default value: NULL

-

The "max-bitrate" property

-
  "max-bitrate"              guint                 : Read
-

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

+

The “max-bitrate” property

+
  “max-bitrate”              guint
+

+

Flags: Read

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

+

The “mode” property

+
  “mode”                     NM80211Mode
+

+

Flags: Read

Default value: NM_802_11_MODE_INFRA

-

The "rsn-flags" property

-
  "rsn-flags"                NM80211ApSecurityFlags  : Read
-

-The RSN flags of the access point. -

+

The “rsn-flags” property

+
  “rsn-flags”                NM80211ApSecurityFlags
+

+

Flags: Read

-

The "ssid" property

-
  "ssid"                     GBytes*               : Read
-

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

+

The “ssid” property

+
  “ssid”                     GBytes *
+

+

Flags: Read

-

The "strength" property

-
  "strength"                 guchar                : Read
-

-The current signal strength of the access point. -

+

The “strength” property

+
  “strength”                 guchar
+

+

Flags: Read

Default value: 0

-

The "wpa-flags" property

-
  "wpa-flags"                NM80211ApSecurityFlags  : Read
-

-The WPA flags of the access point. -

+

The “wpa-flags” property

+
  “wpa-flags”                NM80211ApSecurityFlags
+

+

Flags: Read

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