diff options
Diffstat (limited to 'docs/libnm/html/NMSettingGsm.html')
| -rw-r--r-- | docs/libnm/html/NMSettingGsm.html | 108 |
1 files changed, 84 insertions, 24 deletions
diff --git a/docs/libnm/html/NMSettingGsm.html b/docs/libnm/html/NMSettingGsm.html index be3e09d2..0a80c7f2 100644 --- a/docs/libnm/html/NMSettingGsm.html +++ b/docs/libnm/html/NMSettingGsm.html @@ -93,7 +93,7 @@ </tr> <tr> <td class="function_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<span class="returnvalue">gboolean</span> </td> <td class="function_name"> <a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-home-only" title="nm_setting_gsm_get_home_only ()">nm_setting_gsm_get_home_only</a> <span class="c_punctuation">()</span> @@ -122,6 +122,14 @@ </tr> <tr> <td class="function_type"> +<span class="returnvalue">guint32</span> +</td> +<td class="function_name"> +<a class="link" href="NMSettingGsm.html#nm-setting-gsm-get-mtu" title="nm_setting_gsm_get_mtu ()">nm_setting_gsm_get_mtu</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> </td> <td class="function_name"> @@ -150,36 +158,41 @@ <tbody> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--apn" title="The “apn” property">apn</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--device-id" title="The “device-id” property">device-id</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> -<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> +<td class="property_type"><span class="type">gboolean</span></td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--home-only" title="The “home-only” property">home-only</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> +<td class="property_type"><span class="type">guint</span></td> +<td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--mtu" title="The “mtu” property">mtu</a></td> +<td class="property_flags">Read / Write / Construct</td> +</tr> +<tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--network-id" title="The “network-id” property">network-id</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--number" title="The “number” property">number</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--password" title="The “password” property">password</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -190,7 +203,7 @@ </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--pin" title="The “pin” property">pin</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -201,19 +214,19 @@ </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--sim-id" title="The “sim-id” property">sim-id</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--sim-operator-id" title="The “sim-operator-id” property">sim-operator-id</a></td> <td class="property_flags">Read / Write</td> </tr> <tr> <td class="property_type"> -<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> +<span class="type">gchar</span> *</td> <td class="property_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm--username" title="The “username” property">username</a></td> <td class="property_flags">Read / Write</td> </tr> @@ -281,6 +294,10 @@ <td class="function_name"><a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-SIM-OPERATOR-ID:CAPS" title="NM_SETTING_GSM_SIM_OPERATOR_ID">NM_SETTING_GSM_SIM_OPERATOR_ID</a></td> </tr> <tr> +<td class="define_keyword">#define</td> +<td class="function_name"><a class="link" href="NMSettingGsm.html#NM-SETTING-GSM-MTU:CAPS" title="NM_SETTING_GSM_MTU">NM_SETTING_GSM_MTU</a></td> +</tr> +<tr> <td class="datatype_keyword"> </td> <td class="function_name"><a class="link" href="NMSettingGsm.html#NMSettingGsm-struct" title="NMSettingGsm">NMSettingGsm</a></td> </tr> @@ -289,7 +306,7 @@ </div> <div class="refsect1"> <a name="NMSettingGsm.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a> +<pre class="screen"> GObject <span class="lineart">╰──</span> <a class="link" href="NMSetting.html" title="NMSetting">NMSetting</a> <span class="lineart">╰──</span> NMSettingGsm </pre> @@ -465,7 +482,7 @@ nm_setting_gsm_get_pin (<em class="parameter"><code><a class="link" href="NMSett <hr> <div class="refsect2"> <a name="nm-setting-gsm-get-home-only"></a><h3>nm_setting_gsm_get_home_only ()</h3> -<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> +<pre class="programlisting"><span class="returnvalue">gboolean</span> nm_setting_gsm_get_home_only (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> <div class="refsect3"> <a name="nm-setting-gsm-get-home-only.parameters"></a><h4>Parameters</h4> @@ -567,6 +584,32 @@ nm_setting_gsm_get_sim_operator_id (<em class="parameter"><code><a class="link" </div> <hr> <div class="refsect2"> +<a name="nm-setting-gsm-get-mtu"></a><h3>nm_setting_gsm_get_mtu ()</h3> +<pre class="programlisting"><span class="returnvalue">guint32</span> +nm_setting_gsm_get_mtu (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> +<div class="refsect3"> +<a name="nm-setting-gsm-get-mtu.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>setting</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-setting-gsm-get-mtu.returns"></a><h4>Returns</h4> +<p> the <a class="link" href="NMSettingGsm.html#NMSettingGsm--mtu" title="The “mtu” property"><span class="type">“mtu”</span></a> property of the setting</p> +</div> +<p class="since">Since: 1.8</p> +</div> +<hr> +<div class="refsect2"> <a name="nm-setting-gsm-get-pin-flags"></a><h3>nm_setting_gsm_get_pin_flags ()</h3> <pre class="programlisting"><a class="link" href="NMSetting.html#NMSettingSecretFlags" title="enum NMSettingSecretFlags"><span class="returnvalue">NMSettingSecretFlags</span></a> nm_setting_gsm_get_pin_flags (<em class="parameter"><code><a class="link" href="NMSettingGsm.html" title="NMSettingGsm"><span class="type">NMSettingGsm</span></a> *setting</code></em>);</pre> @@ -697,15 +740,22 @@ nm_setting_gsm_get_password_flags (<em class="parameter"><code><a class="link" h </div> <hr> <div class="refsect2"> +<a name="NM-SETTING-GSM-MTU:CAPS"></a><h3>NM_SETTING_GSM_MTU</h3> +<pre class="programlisting">#define NM_SETTING_GSM_MTU "mtu" +</pre> +</div> +<hr> +<div class="refsect2"> <a name="NMSettingGsm-struct"></a><h3>NMSettingGsm</h3> <pre class="programlisting">typedef struct _NMSettingGsm NMSettingGsm;</pre> +<p>GSM-based Mobile Broadband Settings</p> </div> </div> <div class="refsect1"> <a name="NMSettingGsm.property-details"></a><h2>Property Details</h2> <div class="refsect2"> <a name="NMSettingGsm--apn"></a><h3>The <code class="literal">“apn”</code> property</h3> -<pre class="programlisting"> “apn” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “apn” <span class="type">gchar</span> *</pre> <p>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has @@ -719,7 +769,7 @@ The APN may only be composed of the characters a-z, 0-9, ., and - per GSM <hr> <div class="refsect2"> <a name="NMSettingGsm--device-id"></a><h3>The <code class="literal">“device-id”</code> property</h3> -<pre class="programlisting"> “device-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “device-id” <span class="type">gchar</span> *</pre> <p>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</p> @@ -730,16 +780,26 @@ apply to the specified device.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--home-only"></a><h3>The <code class="literal">“home-only”</code> property</h3> -<pre class="programlisting"> “home-only” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p>When <a href="/usr/share/gtk-doc/html/glibglib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, only connections to the home network will be allowed. +<pre class="programlisting"> “home-only” <span class="type">gboolean</span></pre> +<p>When <code class="literal">TRUE</code>, only connections to the home network will be allowed. Connections to roaming networks will not be made.</p> <p>Flags: Read / Write</p> <p>Default value: FALSE</p> </div> <hr> <div class="refsect2"> +<a name="NMSettingGsm--mtu"></a><h3>The <code class="literal">“mtu”</code> property</h3> +<pre class="programlisting"> “mtu” <span class="type">guint</span></pre> +<p>If non-zero, only transmit packets of the specified size or smaller, +breaking larger packets up into multiple frames.</p> +<p>Flags: Read / Write / Construct</p> +<p>Default value: 0</p> +<p class="since">Since: 1.8</p> +</div> +<hr> +<div class="refsect2"> <a name="NMSettingGsm--network-id"></a><h3>The <code class="literal">“network-id”</code> property</h3> -<pre class="programlisting"> “network-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “network-id” <span class="type">gchar</span> *</pre> <p>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. @@ -751,7 +811,7 @@ roaming control of the device is not otherwise possible.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--number"></a><h3>The <code class="literal">“number”</code> property</h3> -<pre class="programlisting"> “number” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “number” <span class="type">gchar</span> *</pre> <p>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which @@ -762,7 +822,7 @@ allows NetworkManager to select the appropriate settings automatically.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--password"></a><h3>The <code class="literal">“password”</code> property</h3> -<pre class="programlisting"> “password” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “password” <span class="type">gchar</span> *</pre> <p>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</p> @@ -779,7 +839,7 @@ password is required, it is specified here.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--pin"></a><h3>The <code class="literal">“pin”</code> property</h3> -<pre class="programlisting"> “pin” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “pin” <span class="type">gchar</span> *</pre> <p>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</p> @@ -796,7 +856,7 @@ device.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--sim-id"></a><h3>The <code class="literal">“sim-id”</code> property</h3> -<pre class="programlisting"> “sim-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “sim-id” <span class="type">gchar</span> *</pre> <p>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by <a class="link" href="NMSettingGsm.html#NMSettingGsm--device-id" title="The “device-id” property"><span class="type">“device-id”</span></a> which contains a @@ -808,7 +868,7 @@ SIM card matching the given identifier.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--sim-operator-id"></a><h3>The <code class="literal">“sim-operator-id”</code> property</h3> -<pre class="programlisting"> “sim-operator-id” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “sim-operator-id” <span class="type">gchar</span> *</pre> <p>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by @@ -821,7 +881,7 @@ card provisioined by the given operator.</p> <hr> <div class="refsect2"> <a name="NMSettingGsm--username"></a><h3>The <code class="literal">“username”</code> property</h3> -<pre class="programlisting"> “username” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> +<pre class="programlisting"> “username” <span class="type">gchar</span> *</pre> <p>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</p> |