diff options
Diffstat (limited to 'docs/libnm/html/NMWimaxNsp.html')
| -rw-r--r-- | docs/libnm/html/NMWimaxNsp.html | 539 |
1 files changed, 303 insertions, 236 deletions
diff --git a/docs/libnm/html/NMWimaxNsp.html b/docs/libnm/html/NMWimaxNsp.html index fa705867..6b4d8307 100644 --- a/docs/libnm/html/NMWimaxNsp.html +++ b/docs/libnm/html/NMWimaxNsp.html @@ -2,36 +2,28 @@ <html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> -<title>NMWimaxNsp</title> +<title>libnm Reference Manual: NMWimaxNsp</title> <meta name="generator" content="DocBook XSL Stylesheets V1.78.1"> <link rel="home" href="index.html" title="libnm Reference Manual"> <link rel="up" href="ch04.html" title="Device and Runtime Configuration API Reference"> <link rel="prev" href="NMAccessPoint.html" title="NMAccessPoint"> <link rel="next" href="NMIPConfig.html" title="NMIPConfig"> -<meta name="generator" content="GTK-Doc V1.19 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.21 (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="2"> -<tr valign="middle"> -<td><a accesskey="p" href="NMAccessPoint.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> -<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td> -<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td> -<th width="100%" align="center">libnm Reference Manual</th> -<td><a accesskey="n" href="NMIPConfig.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> -</tr> -<tr><td colspan="5" class="shortcuts"> -<a href="#NMWimaxNsp.synopsis" class="shortcut">Top</a> - | - <a href="#NMWimaxNsp.description" class="shortcut">Description</a> - | - <a href="#NMWimaxNsp.object-hierarchy" class="shortcut">Object Hierarchy</a> - | - <a href="#NMWimaxNsp.implemented-interfaces" class="shortcut">Implemented Interfaces</a> - | - <a href="#NMWimaxNsp.properties" class="shortcut">Properties</a> -</td></tr> -</table> +<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="#NMWimaxNsp.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> + <a href="#NMWimaxNsp.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span> + <a href="#NMWimaxNsp.properties" class="shortcut">Properties</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> +<td><a accesskey="p" href="NMAccessPoint.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="NMIPConfig.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> <div class="refentry"> <a name="NMWimaxNsp"></a><div class="titlepage"></div> <div class="refnamediv"><table width="100%"><tr> @@ -39,312 +31,387 @@ <h2><span class="refentrytitle"><a name="NMWimaxNsp.top_of_page"></a>NMWimaxNsp</span></h2> <p>NMWimaxNsp</p> </td> -<td valign="top" align="right"></td> +<td class="gallery_image" valign="top" align="right"></td> </tr></table></div> -<div class="refsynopsisdiv"> -<a name="NMWimaxNsp.synopsis"></a><h2>Synopsis</h2> -<a name="NMWimaxNspNetworkType"></a><pre class="synopsis">#define <a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-NAME:CAPS" title="NM_WIMAX_NSP_NAME">NM_WIMAX_NSP_NAME</a> -#define <a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-SIGNAL-QUALITY:CAPS" title="NM_WIMAX_NSP_SIGNAL_QUALITY">NM_WIMAX_NSP_SIGNAL_QUALITY</a> -#define <a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-NETWORK-TYPE:CAPS" title="NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a> -enum <a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType-enum" title="enum NMWimaxNspNetworkType">NMWimaxNspNetworkType</a>; -struct <a class="link" href="NMWimaxNsp.html#NMWimaxNsp-struct" title="struct NMWimaxNsp">NMWimaxNsp</a>; - <a class="link" href="NMWimaxNsp.html#NMWimaxNspClass" title="NMWimaxNspClass">NMWimaxNspClass</a>; -const <span class="returnvalue">char</span> * <a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-name" title="nm_wimax_nsp_get_name ()">nm_wimax_nsp_get_name</a> (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> <a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-signal-quality" title="nm_wimax_nsp_get_signal_quality ()">nm_wimax_nsp_get_signal_quality</a> (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>); -<a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType"><span class="returnvalue">NMWimaxNspNetworkType</span></a> <a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-network-type" title="nm_wimax_nsp_get_network_type ()">nm_wimax_nsp_get_network_type</a> (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * <a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-filter-connections" title="nm_wimax_nsp_filter_connections ()">nm_wimax_nsp_filter_connections</a> (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *connections</code></em>); -<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-connection-valid" title="nm_wimax_nsp_connection_valid ()">nm_wimax_nsp_connection_valid</a> (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>); -</pre> -</div> -<div class="refsect1"> -<a name="NMWimaxNsp.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="synopsis"> - GEnum - +----NMWimaxNspNetworkType -</pre> -<pre class="synopsis"> - <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a> - +----<a class="link" href="NMObject.html" title="NMObject">NMObject</a> - +----NMWimaxNsp -</pre> -</div> -<div class="refsect1"> -<a name="NMWimaxNsp.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMWimaxNsp implements - <a href="http://library.gnome.org/devel/gio/unstable/GInitable.html">GInitable</a> and <a href="http://library.gnome.org/devel/gio/unstable/GAsyncInitable.html">GAsyncInitable</a>.</p> -</div> -<div class="refsect1"> -<a name="NMWimaxNsp.properties"></a><h2>Properties</h2> -<pre class="synopsis"> - "<a class="link" href="NMWimaxNsp.html#NMWimaxNsp--name" title='The "name" property'>name</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read - "<a class="link" href="NMWimaxNsp.html#NMWimaxNsp--network-type" title='The "network-type" property'>network-type</a>" <a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType"><span class="type">NMWimaxNspNetworkType</span></a> : Read - "<a class="link" href="NMWimaxNsp.html#NMWimaxNsp--signal-quality" title='The "signal-quality" property'>signal-quality</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read -</pre> -</div> <div class="refsect1"> -<a name="NMWimaxNsp.description"></a><h2>Description</h2> -<p> -</p> -</div> -<div class="refsect1"> -<a name="NMWimaxNsp.details"></a><h2>Details</h2> -<div class="refsect2"> -<a name="NM-WIMAX-NSP-NAME:CAPS"></a><h3>NM_WIMAX_NSP_NAME</h3> -<pre class="programlisting">#define NM_WIMAX_NSP_NAME "name" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-WIMAX-NSP-SIGNAL-QUALITY:CAPS"></a><h3>NM_WIMAX_NSP_SIGNAL_QUALITY</h3> -<pre class="programlisting">#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NM-WIMAX-NSP-NETWORK-TYPE:CAPS"></a><h3>NM_WIMAX_NSP_NETWORK_TYPE</h3> -<pre class="programlisting">#define NM_WIMAX_NSP_NETWORK_TYPE "network-type" -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMWimaxNspNetworkType-enum"></a><h3>enum NMWimaxNspNetworkType</h3> -<pre class="programlisting">typedef enum { - NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0, - NM_WIMAX_NSP_NETWORK_TYPE_HOME = 1, - NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 2, - NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 3 -} NMWimaxNspNetworkType; -</pre> -<p> -WiMAX network type. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="NMWimaxNsp.functions"></a><h2>Functions</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="functions_return"> +<col class="functions_name"> </colgroup> <tbody> <tr> -<td><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-UNKNOWN:CAPS"></a><span class="term"><code class="literal">NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN</code></span></p></td> -<td>unknown network type +<td class="function_type">const <span class="returnvalue">char</span> * +</td> +<td class="function_name"> +<a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-name" title="nm_wimax_nsp_get_name ()">nm_wimax_nsp_get_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">guint32</span> +</td> +<td class="function_name"> +<a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-signal-quality" title="nm_wimax_nsp_get_signal_quality ()">nm_wimax_nsp_get_signal_quality</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-HOME:CAPS"></a><span class="term"><code class="literal">NM_WIMAX_NSP_NETWORK_TYPE_HOME</code></span></p></td> -<td>home network +<td class="function_type"> +<a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType" title="enum NMWimaxNspNetworkType"><span class="returnvalue">NMWimaxNspNetworkType</span></a> +</td> +<td class="function_name"> +<a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-get-network-type" title="nm_wimax_nsp_get_network_type ()">nm_wimax_nsp_get_network_type</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-PARTNER:CAPS"></a><span class="term"><code class="literal">NM_WIMAX_NSP_NETWORK_TYPE_PARTNER</code></span></p></td> -<td>partner network +<td class="function_type"> +<span class="returnvalue">GPtrArray</span> * +</td> +<td class="function_name"> +<a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-filter-connections" title="nm_wimax_nsp_filter_connections ()">nm_wimax_nsp_filter_connections</a> <span class="c_punctuation">()</span> </td> </tr> <tr> -<td><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-ROAMING-PARTNER:CAPS"></a><span class="term"><code class="literal">NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER</code></span></p></td> -<td>roaming partner network +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="NMWimaxNsp.html#nm-wimax-nsp-connection-valid" title="nm_wimax_nsp_connection_valid ()">nm_wimax_nsp_connection_valid</a> <span class="c_punctuation">()</span> </td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="NMWimaxNsp-struct"></a><h3>struct NMWimaxNsp</h3> -<pre class="programlisting">struct NMWimaxNsp;</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMWimaxNspClass"></a><h3>NMWimaxNspClass</h3> -<pre class="programlisting">typedef struct { - NMObjectClass parent; -} NMWimaxNspClass; -</pre> -<p> -</p> -</div> -<hr> -<div class="refsect2"> -<a name="nm-wimax-nsp-get-name"></a><h3>nm_wimax_nsp_get_name ()</h3> -<pre class="programlisting">const <span class="returnvalue">char</span> * nm_wimax_nsp_get_name (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> -<p> -Gets the name of the wimax NSP -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<div class="refsect1"> +<a name="NMWimaxNsp.properties"></a><h2>Properties</h2> +<div class="informaltable"><table border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="properties_type"> +<col width="300px" class="properties_name"> +<col width="200px" class="properties_flags"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>nsp</code></em> :</span></p></td> -<td>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> -</td> +<td class="property_type"> +<span class="type">gchar</span> *</td> +<td class="property_name"><a class="link" href="NMWimaxNsp.html#NMWimaxNsp--name" title="The “name” property">name</a></td> +<td class="property_flags">Read</td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the name</td> +<td class="property_type"><a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType" title="enum NMWimaxNspNetworkType"><span class="type">NMWimaxNspNetworkType</span></a></td> +<td class="property_name"><a class="link" href="NMWimaxNsp.html#NMWimaxNsp--network-type" title="The “network-type” property">network-type</a></td> +<td class="property_flags">Read</td> +</tr> +<tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMWimaxNsp.html#NMWimaxNsp--signal-quality" title="The “signal-quality” property">signal-quality</a></td> +<td class="property_flags">Read</td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="nm-wimax-nsp-get-signal-quality"></a><h3>nm_wimax_nsp_get_signal_quality ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint32"><span class="returnvalue">guint32</span></a> nm_wimax_nsp_get_signal_quality (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> -<p> -Gets the WPA signal quality of the wimax NSP. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<div class="refsect1"> +<a name="NMWimaxNsp.other"></a><h2>Types and Values</h2> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="name"> +<col class="description"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>nsp</code></em> :</span></p></td> -<td>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> -</td> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-NAME:CAPS" title="NM_WIMAX_NSP_NAME">NM_WIMAX_NSP_NAME</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-SIGNAL-QUALITY:CAPS" title="NM_WIMAX_NSP_SIGNAL_QUALITY">NM_WIMAX_NSP_SIGNAL_QUALITY</a></td> +</tr> +<tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMWimaxNsp.html#NM-WIMAX-NSP-NETWORK-TYPE:CAPS" title="NM_WIMAX_NSP_NETWORK_TYPE">NM_WIMAX_NSP_NETWORK_TYPE</a></td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the signal quality</td> +<td class="datatype_keyword">enum</td> +<td class="function_name"><a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType" title="enum NMWimaxNspNetworkType">NMWimaxNspNetworkType</a></td> </tr> </tbody> </table></div> </div> -<hr> -<div class="refsect2"> -<a name="nm-wimax-nsp-get-network-type"></a><h3>nm_wimax_nsp_get_network_type ()</h3> -<pre class="programlisting"><a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType"><span class="returnvalue">NMWimaxNspNetworkType</span></a> nm_wimax_nsp_get_network_type (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> +<div class="refsect1"> +<a name="NMWimaxNsp.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-Enumeration-and-Flag-Types.html">GEnum</a> + <span class="lineart">╰──</span> NMWimaxNspNetworkType + GObject + <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> + <span class="lineart">╰──</span> NMWimaxNsp +</pre> +</div> +<div class="refsect1"> +<a name="NMWimaxNsp.description"></a><h2>Description</h2> <p> -Gets the network type of the wimax NSP. </p> -<div class="variablelist"><table border="0" class="variablelist"> +</div> +<div class="refsect1"> +<a name="NMWimaxNsp.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="nm-wimax-nsp-get-name"></a><h3>nm_wimax_nsp_get_name ()</h3> +<pre class="programlisting">const <span class="returnvalue">char</span> * +nm_wimax_nsp_get_name (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> +<p>Gets the name of the wimax NSP</p> +<div class="refsect3"> +<a name="id-1.5.20.8.2.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>nsp</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.5.20.8.2.6"></a><h4>Returns</h4> +<p> the name</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-wimax-nsp-get-signal-quality"></a><h3>nm_wimax_nsp_get_signal_quality ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> +nm_wimax_nsp_get_signal_quality (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> +<p>Gets the WPA signal quality of the wimax NSP.</p> +<div class="refsect3"> +<a name="id-1.5.20.8.3.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>nsp</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.5.20.8.3.6"></a><h4>Returns</h4> +<p> the signal quality</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-wimax-nsp-get-network-type"></a><h3>nm_wimax_nsp_get_network_type ()</h3> +<pre class="programlisting"><a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType" title="enum NMWimaxNspNetworkType"><span class="returnvalue">NMWimaxNspNetworkType</span></a> +nm_wimax_nsp_get_network_type (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>);</pre> +<p>Gets the network type of the wimax NSP.</p> +<div class="refsect3"> +<a name="id-1.5.20.8.4.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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>nsp</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="id-1.5.20.8.4.6"></a><h4>Returns</h4> +<p> the network type</p> +<p></p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-wimax-nsp-filter-connections"></a><h3>nm_wimax_nsp_filter_connections ()</h3> +<pre class="programlisting"><span class="returnvalue">GPtrArray</span> * +nm_wimax_nsp_filter_connections (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, + <em class="parameter"><code>const <span class="type">GPtrArray</span> *connections</code></em>);</pre> +<p>Filters a given array of connections for a given <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> object and +return connections which may be activated with the NSP. Any returned +connections will match the <em class="parameter"><code>nsp</code></em> +'s network name and other attributes.</p> +<div class="refsect3"> +<a name="id-1.5.20.8.5.5"></a><h4>Parameters</h4> +<div class="informaltable"><table 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><p><span class="term"><em class="parameter"><code>nsp</code></em> :</span></p></td> -<td>a <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> -</td> +<td class="parameter_name"><p>nsp</p></td> +<td class="parameter_description"><p>an <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> to filter connections for</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>the network type</td> +<td class="parameter_name"><p>connections</p></td> +<td class="parameter_description"><p> an array of <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> to +filter. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span></td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.5.20.8.5.6"></a><h4>Returns</h4> +<p> an array of +<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>nsp</code></em> +. The array should +be freed with <code class="function">g_ptr_array_unref()</code> when it is no longer required. </p> +<p><span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span></p> +</div> +</div> <hr> <div class="refsect2"> -<a name="nm-wimax-nsp-filter-connections"></a><h3>nm_wimax_nsp_filter_connections ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="returnvalue">GPtrArray</span></a> * nm_wimax_nsp_filter_connections (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, - <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *connections</code></em>);</pre> -<p> -Filters a given array of connections for a given <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> object and -return connections which may be activated with the NSP. Any returned -connections will match the <em class="parameter"><code>nsp</code></em>'s network name and other attributes. -</p> -<div class="variablelist"><table border="0" class="variablelist"> +<a name="nm-wimax-nsp-connection-valid"></a><h3>nm_wimax_nsp_connection_valid ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +nm_wimax_nsp_connection_valid (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> +<p>Validates a given connection against a given WiMAX NSP to ensure that the +connection may be activated with that NSP. The connection must match the +<em class="parameter"><code>nsp</code></em> +'s network name and other attributes.</p> +<div class="refsect3"> +<a name="id-1.5.20.8.6.5"></a><h4>Parameters</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>nsp</code></em> :</span></p></td> -<td>an <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> to filter connections for</td> -</tr> -<tr> -<td><p><span class="term"><em class="parameter"><code>connections</code></em> :</span></p></td> -<td>an array of <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> to -filter. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span> -</td> +<td class="parameter_name"><p>nsp</p></td> +<td class="parameter_description"><p>an <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> to validate <em class="parameter"><code>connection</code></em> +against</p></td> +<td class="parameter_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td>an array of -<a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnections</span></a> that could be activated with the given <em class="parameter"><code>nsp</code></em>. The array should -be freed with <a href="http://library.gnome.org/devel/glib/unstable/glib-Pointer-Arrays.html#g-ptr-array-unref"><code class="function">g_ptr_array_unref()</code></a> when it is no longer required. <span class="annotation">[<acronym title="Free data container after the code is done."><span class="acronym">transfer container</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> NMConnection]</span> -</td> +<td class="parameter_name"><p>connection</p></td> +<td class="parameter_description"><p>an <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>nsp</code></em> +</p></td> +<td class="parameter_annotations"> </td> </tr> </tbody> </table></div> </div> +<div class="refsect3"> +<a name="id-1.5.20.8.6.6"></a><h4>Returns</h4> +<p> <code class="literal">TRUE</code> if the connection may be activated with this WiMAX NSP, +<code class="literal">FALSE</code> if it cannot be.</p> +<p></p> +</div> +</div> +</div> +<div class="refsect1"> +<a name="NMWimaxNsp.other_details"></a><h2>Types and Values</h2> +<div class="refsect2"> +<a name="NM-WIMAX-NSP-NAME:CAPS"></a><h3>NM_WIMAX_NSP_NAME</h3> +<pre class="programlisting">#define NM_WIMAX_NSP_NAME "name" +</pre> +<p> +</p> +</div> <hr> <div class="refsect2"> -<a name="nm-wimax-nsp-connection-valid"></a><h3>nm_wimax_nsp_connection_valid ()</h3> -<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_wimax_nsp_connection_valid (<em class="parameter"><code><a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> *nsp</code></em>, - <em class="parameter"><code><a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> *connection</code></em>);</pre> +<a name="NM-WIMAX-NSP-SIGNAL-QUALITY:CAPS"></a><h3>NM_WIMAX_NSP_SIGNAL_QUALITY</h3> +<pre class="programlisting">#define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality" +</pre> <p> -Validates a given connection against a given WiMAX NSP to ensure that the -connection may be activated with that NSP. The connection must match the -<em class="parameter"><code>nsp</code></em>'s network name and other attributes. </p> -<div class="variablelist"><table border="0" class="variablelist"> +</div> +<hr> +<div class="refsect2"> +<a name="NM-WIMAX-NSP-NETWORK-TYPE:CAPS"></a><h3>NM_WIMAX_NSP_NETWORK_TYPE</h3> +<pre class="programlisting">#define NM_WIMAX_NSP_NETWORK_TYPE "network-type" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMWimaxNspNetworkType"></a><h3>enum NMWimaxNspNetworkType</h3> +<p>WiMAX network type.</p> +<div class="refsect3"> +<a name="id-1.5.20.9.5.4"></a><h4>Members</h4> +<div class="informaltable"><table width="100%" border="0"> <colgroup> -<col align="left" valign="top"> -<col> +<col width="300px" class="enum_members_name"> +<col class="enum_members_description"> +<col width="200px" class="enum_members_annotations"> </colgroup> <tbody> <tr> -<td><p><span class="term"><em class="parameter"><code>nsp</code></em> :</span></p></td> -<td>an <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> to validate <em class="parameter"><code>connection</code></em> against</td> +<td class="enum_member_name"><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-UNKNOWN:CAPS"></a>NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN</p></td> +<td class="enum_member_description"> +<p>unknown network type</p> +</td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><em class="parameter"><code>connection</code></em> :</span></p></td> -<td>an <a href="https://developer.gnome.org/libnm-util/0.9/NMConnection.html"><span class="type">NMConnection</span></a> to validate against <em class="parameter"><code>nsp</code></em> +<td class="enum_member_name"><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-HOME:CAPS"></a>NM_WIMAX_NSP_NETWORK_TYPE_HOME</p></td> +<td class="enum_member_description"> +<p>home network</p> </td> +<td class="enum_member_annotations"> </td> </tr> <tr> -<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> -<td> -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the connection may be activated with this WiMAX NSP, -<a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if it cannot be.</td> +<td class="enum_member_name"><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-PARTNER:CAPS"></a>NM_WIMAX_NSP_NETWORK_TYPE_PARTNER</p></td> +<td class="enum_member_description"> +<p>partner network</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> +<td class="enum_member_name"><p><a name="NM-WIMAX-NSP-NETWORK-TYPE-ROAMING-PARTNER:CAPS"></a>NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER</p></td> +<td class="enum_member_description"> +<p>roaming partner network</p> +</td> +<td class="enum_member_annotations"> </td> </tr> </tbody> </table></div> </div> </div> +</div> <div class="refsect1"> <a name="NMWimaxNsp.property-details"></a><h2>Property Details</h2> <div class="refsect2"> -<a name="NMWimaxNsp--name"></a><h3>The <code class="literal">"name"</code> property</h3> -<pre class="programlisting"> "name" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read</pre> -<p> -The name of the WiMAX NSP. -</p> +<a name="NMWimaxNsp--name"></a><h3>The <code class="literal">“name”</code> property</h3> +<pre class="programlisting"> “name” <span class="type">gchar</span> *</pre> +<p></p> +<p>Flags: Read</p> <p>Default value: NULL</p> </div> <hr> <div class="refsect2"> -<a name="NMWimaxNsp--network-type"></a><h3>The <code class="literal">"network-type"</code> property</h3> -<pre class="programlisting"> "network-type" <a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType"><span class="type">NMWimaxNspNetworkType</span></a> : Read</pre> -<p> -The network type of the WiMAX NSP. -</p> +<a name="NMWimaxNsp--network-type"></a><h3>The <code class="literal">“network-type”</code> property</h3> +<pre class="programlisting"> “network-type” <a class="link" href="NMWimaxNsp.html#NMWimaxNspNetworkType" title="enum NMWimaxNspNetworkType"><span class="type">NMWimaxNspNetworkType</span></a></pre> +<p></p> +<p>Flags: Read</p> <p>Default value: NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN</p> </div> <hr> <div class="refsect2"> -<a name="NMWimaxNsp--signal-quality"></a><h3>The <code class="literal">"signal-quality"</code> property</h3> -<pre class="programlisting"> "signal-quality" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read</pre> -<p> -The signal quality of the WiMAX NSP. -</p> +<a name="NMWimaxNsp--signal-quality"></a><h3>The <code class="literal">“signal-quality”</code> property</h3> +<pre class="programlisting"> “signal-quality” <span class="type">guint</span></pre> +<p></p> +<p>Flags: Read</p> <p>Allowed values: <= 100</p> <p>Default value: 0</p> </div> @@ -352,6 +419,6 @@ The signal quality of the WiMAX NSP. </div> <div class="footer"> <hr> - Generated by GTK-Doc V1.19</div> + Generated by GTK-Doc V1.21</div> </body> </html> \ No newline at end of file |