diff options
Diffstat (limited to 'docs/libnm/html/NMDeviceWifi.html')
| -rw-r--r-- | docs/libnm/html/NMDeviceWifi.html | 247 |
1 files changed, 241 insertions, 6 deletions
diff --git a/docs/libnm/html/NMDeviceWifi.html b/docs/libnm/html/NMDeviceWifi.html index 3d28400e..c4f212bc 100644 --- a/docs/libnm/html/NMDeviceWifi.html +++ b/docs/libnm/html/NMDeviceWifi.html @@ -8,14 +8,17 @@ <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMDeviceWifiP2P.html" title="NMDeviceWifiP2P"> <link rel="next" href="NMDeviceWimax.html" title="NMDeviceWimax"> -<meta name="generator" content="GTK-Doc V1.33.0 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#NMDeviceWifi.description" class="shortcut">Description</a></span> + <a href="#NMDeviceWifi.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMDeviceWifi.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMDeviceWifi.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span> + <a href="#NMDeviceWifi.signals" class="shortcut">Signals</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch04.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -152,6 +155,78 @@ </table></div> </div> <div class="refsect1"> +<a name="NMDeviceWifi.properties"></a><h2>Properties</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> +</colgroup> +<tbody> +<tr> +<td class="property_type"> +<a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--access-points" title="The “access-points” property">access-points</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *</td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--active-access-point" title="The “active-access-point” property">active-access-point</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--bitrate" title="The “bitrate” property">bitrate</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--last-scan" title="The “last-scan” property">last-scan</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="libnm-nm-dbus-interface.html#NM80211Mode" title="enum NM80211Mode"><span class="type">NM80211Mode</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--mode" title="The “mode” property">mode</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"> +<span class="type">char</span> *</td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--perm-hw-address" title="The “perm-hw-address” property">perm-hw-address</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><a class="link" href="libnm-nm-dbus-interface.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a></td> +<td class="property_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi--wireless-capabilities" title="The “wireless-capabilities” property">wireless-capabilities</a></td> +<td class="property_flags">Read</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="NMDeviceWifi.signals"></a><h2>Signals</h2> +<div class="informaltable"><table class="informaltable" border="0"> +<colgroup> +<col width="150px" class="signal_proto_type"> +<col width="300px" class="signal_proto_name"> +<col width="200px" class="signal_proto_flags"> +</colgroup> +<tbody> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi-access-point-added" title="The “access-point-added” signal">access-point-added</a></td> +<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +<tr> +<td class="signal_type"><span class="returnvalue">void</span></td> +<td class="signal_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi-access-point-removed" title="The “access-point-removed” signal">access-point-removed</a></td> +<td class="signal_flags"><a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> <a name="NMDeviceWifi.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -191,10 +266,22 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMDeviceWifi.html#NM-DEVICE-WIFI-LAST-SCAN:CAPS" title="NM_DEVICE_WIFI_LAST_SCAN">NM_DEVICE_WIFI_LAST_SCAN</a></td> </tr> +<tr> +<td class="datatype_keyword"> </td> +<td class="function_name"><a class="link" href="NMDeviceWifi.html#NMDeviceWifi-struct" title="NMDeviceWifi">NMDeviceWifi</a></td> +</tr> </tbody> </table></div> </div> <div class="refsect1"> +<a name="NMDeviceWifi.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> <a class="link" href="NMDevice.html" title="NMDevice">NMDevice</a> + <span class="lineart">╰──</span> NMDeviceWifi +</pre> +</div> +<div class="refsect1"> <a name="NMDeviceWifi.description"></a><h2>Description</h2> </div> <div class="refsect1"> @@ -361,7 +448,7 @@ nm_device_wifi_get_active_access_point <div class="refsect3"> <a name="nm-device-wifi-get-active-access-point.returns"></a><h4>Returns</h4> <p>the access point or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is active. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -397,7 +484,7 @@ nm_device_wifi_get_access_point_by_path <div class="refsect3"> <a name="nm-device-wifi-get-access-point-by-path.returns"></a><h4>Returns</h4> <p>the access point or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if none is found. </p> -<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p> +<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p> </div> </div> <hr> @@ -424,7 +511,7 @@ nm_device_wifi_get_access_points (<em class="parameter"><code><a class="link" hr <div class="refsect3"> <a name="nm-device-wifi-get-access-points.returns"></a><h4>Returns</h4> <p>a <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> containing all the -scanned <span class="type">NMAccessPoints</span>. +scanned <a href="NMAccessPoint.html#NMAccessPoint-struct"><span class="type">NMAccessPoints</span></a>. The returned array is owned by the client and should not be modified. </p> <p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMAccessPoint]</span></p> </div> @@ -772,9 +859,157 @@ set.</p> <pre class="programlisting">#define NM_DEVICE_WIFI_LAST_SCAN "last-scan" </pre> </div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi-struct"></a><h3>NMDeviceWifi</h3> +<pre class="programlisting">typedef struct _NMDeviceWifi NMDeviceWifi;</pre> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceWifi.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMDeviceWifi--access-points"></a><h3>The <code class="literal">“access-points”</code> property</h3> +<pre class="programlisting"> “access-points” <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</pre> +<p>List of all Wi-Fi access points the device can see.</p> +<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(NMAccessPoint)]</span></p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--active-access-point"></a><h3>The <code class="literal">“active-access-point”</code> property</h3> +<pre class="programlisting"> “active-access-point” <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> *</pre> +<p>The active <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> of the device.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--bitrate"></a><h3>The <code class="literal">“bitrate”</code> property</h3> +<pre class="programlisting"> “bitrate” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> +<p>The bit rate of the device in kbit/s.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--last-scan"></a><h3>The <code class="literal">“last-scan”</code> property</h3> +<pre class="programlisting"> “last-scan” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gint64"><span class="type">gint64</span></a></pre> +<p>The timestamp (in CLOCK_BOOTTIME seconds) for the last finished +network scan. A value of -1 means the device never scanned for +access points.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +<p>Allowed values: >= -1</p> +<p>Default value: -1</p> +<p class="since">Since: 1.12</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--mode"></a><h3>The <code class="literal">“mode”</code> property</h3> +<pre class="programlisting"> “mode” <a class="link" href="libnm-nm-dbus-interface.html#NM80211Mode" title="enum NM80211Mode"><span class="type">NM80211Mode</span></a></pre> +<p>The mode of the device.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +<p>Default value: NM_802_11_MODE_UNKNOWN</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--perm-hw-address"></a><h3>The <code class="literal">“perm-hw-address”</code> property</h3> +<pre class="programlisting"> “perm-hw-address” <span class="type">char</span> *</pre> +<p>The hardware (MAC) address of the device.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +<p>Default value: NULL</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi--wireless-capabilities"></a><h3>The <code class="literal">“wireless-capabilities”</code> property</h3> +<pre class="programlisting"> “wireless-capabilities” <a class="link" href="libnm-nm-dbus-interface.html#NMDeviceWifiCapabilities" title="enum NMDeviceWifiCapabilities"><span class="type">NMDeviceWifiCapabilities</span></a></pre> +<p>The wireless capabilities of the device.</p> +<p>Owner: NMDeviceWifi</p> +<p>Flags: Read</p> +</div> +</div> +<div class="refsect1"> +<a name="NMDeviceWifi.signal-details"></a><h2>Signal Details</h2> +<div class="refsect2"> +<a name="NMDeviceWifi-access-point-added"></a><h3>The <code class="literal">“access-point-added”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device, + <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *ap, + <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notifies that a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> is added to the Wi-Fi device.</p> +<div class="refsect3"> +<a name="NMDeviceWifi-access-point-added.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>the Wi-Fi device that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ap</p></td> +<td class="parameter_description"><p>the new access point</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="NMDeviceWifi-access-point-removed"></a><h3>The <code class="literal">“access-point-removed”</code> signal</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +user_function (<a class="link" href="NMDeviceWifi.html" title="NMDeviceWifi"><span class="type">NMDeviceWifi</span></a> *device, + <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct"><span class="type">GObject</span></a> *ap, + <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data)</pre> +<p>Notifies that a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> is removed from the Wi-Fi device.</p> +<div class="refsect3"> +<a name="NMDeviceWifi-access-point-removed.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>the Wi-Fi device that received the signal</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>ap</p></td> +<td class="parameter_description"><p>the removed access point</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p>Flags: <a href="https://developer.gnome.org/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS">Run First</a></p> +</div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.33.0</div> +<hr>Generated by GTK-Doc V1.33.1</div> </body> </html> \ No newline at end of file |