libnm-glib Reference Manual | ||||
---|---|---|---|---|
Top | Description | Object Hierarchy | Implemented Interfaces | Properties |
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 NMAccessPoint; NMAccessPointClass; GObject * nm_access_point_new (DBusGConnection *connection
,const char *path
); 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
); const GByteArray * 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
); GSList * nm_access_point_filter_connections (NMAccessPoint *ap
,const GSList *connections
); gboolean nm_access_point_connection_valid (NMAccessPoint *ap
,NMConnection *connection
); const char * nm_access_point_get_hw_address (NMAccessPoint *ap
);
Properties
"bssid" gchar* : Read "flags" guint : Read "frequency" guint : Read "hw-address" gchar* : Read "max-bitrate" guint : Read "mode" guint : Read "rsn-flags" guint : Read "ssid" NMSsid* : Read "strength" guchar : Read "wpa-flags" guint : Read
Details
NMAccessPointClass
typedef struct { NMObjectClass parent; /* Padding for future expansion */ void (*_reserved1) (void); void (*_reserved2) (void); void (*_reserved3) (void); void (*_reserved4) (void); void (*_reserved5) (void); void (*_reserved6) (void); } NMAccessPointClass;
nm_access_point_new ()
GObject * nm_access_point_new (DBusGConnection *connection
,const char *path
);
Creates a new NMAccessPoint.
|
the DBusGConnection |
|
the DBusobject path of the access point |
Returns : |
a new access point. [transfer full] |
nm_access_point_get_flags ()
NM80211ApFlags nm_access_point_get_flags (NMAccessPoint *ap
);
Gets the flags of the access point.
|
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.
|
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.
|
a NMAccessPoint |
Returns : |
the RSN flags |
nm_access_point_get_ssid ()
const GByteArray * nm_access_point_get_ssid (NMAccessPoint *ap
);
Gets the SSID of the access point.
|
a NMAccessPoint |
Returns : |
the GByteArray containing the SSID. This is the internal copy used by the access point, and must not be modified. |
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.
|
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.
|
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.
|
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.
|
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.
|
a NMAccessPoint |
Returns : |
the signal strength |
nm_access_point_filter_connections ()
GSList * nm_access_point_filter_connections (NMAccessPoint *ap
,const GSList *connections
);
Filters a given list of connections for a given NMAccessPoint object and
return 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_remote_settings_list_connections()
and then filter the returned list
for a given NMDevice using nm_device_filter_connections()
and finally
filter that list with this function.
|
an NMAccessPoint to filter connections for |
|
a list of NMConnection objects to filter. [element-type NetworkManager.Connection] |
Returns : |
a
list of NMConnection objects that could be activated with the given ap .
The elements of the list are owned by their creator and should not be freed
by the caller, but the returned list itself is owned by the caller and should
be freed with g_slist_free() when it is no longer required. [transfer container][element-type NetworkManager.Connection]
|
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.
|
an NMAccessPoint to validate connection against |
|
an NMConnection to validate against ap
|
Returns : |
TRUE if the connection may be activated with this Wi-Fi AP,
FALSE if it cannot be. |
nm_access_point_get_hw_address ()
const char * nm_access_point_get_hw_address (NMAccessPoint *ap
);
Warning
nm_access_point_get_hw_address
has been deprecated since version 0.9 and should not be used in newly-written code. Use nm_access_point_get_bssid()
instead.
Gets the hardware (MAC) address of the access point.
|
a NMAccessPoint |
Returns : |
the hardware address of the access point. This is the internal string used by the access point and must not be modified. |
Property Details
The "flags"
property
"flags" guint : Read
The flags of the access point.
Allowed values: <= 1
Default value: 0
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
The hardware address of the access point.
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" guint : 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).
Allowed values: [1,2]
Default value: 2
The "rsn-flags"
property
"rsn-flags" guint : Read
The RSN flags of the access point.
Default value: 0
The "strength"
property
"strength" guchar : Read
The current signal strength of the access point.
Default value: 0
The "wpa-flags"
property
"wpa-flags" guint : Read
The WPA flags of the access point.
Default value: 0