diff options
| author | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2015-01-22 00:29:39 +0100 |
| commit | 2c032d8f1c6292c1338a615e6ec40252889ba85c (patch) | |
| tree | 1f77182220b2b0264288ba4a476ab47e5bc48716 /docs/libnm/html/NMSettingSerial.html | |
| parent | 33491bc4279481db8ae47213e34a6d695a0e8830 (diff) | |
Imported Upstream version 1.0.0 upstream/1.0.0
Diffstat (limited to 'docs/libnm/html/NMSettingSerial.html')
| -rw-r--r-- | docs/libnm/html/NMSettingSerial.html | 381 |
1 files changed, 381 insertions, 0 deletions
diff --git a/docs/libnm/html/NMSettingSerial.html b/docs/libnm/html/NMSettingSerial.html new file mode 100644 index 00000000..65971e1c --- /dev/null +++ b/docs/libnm/html/NMSettingSerial.html @@ -0,0 +1,381 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>NMSettingSerial</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="ch03.html" title="Connection and Setting API Reference"> +<link rel="prev" href="NMSettingPppoe.html" title="NMSettingPppoe"> +<link rel="next" href="NMSettingTeam.html" title="NMSettingTeam"> +<meta name="generator" content="GTK-Doc V1.19 (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="NMSettingPppoe.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td> +<td><a accesskey="u" href="ch03.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="NMSettingTeam.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td> +</tr> +<tr><td colspan="5" class="shortcuts"> +<a href="#NMSettingSerial.synopsis" class="shortcut">Top</a> + | + <a href="#NMSettingSerial.description" class="shortcut">Description</a> + | + <a href="#NMSettingSerial.object-hierarchy" class="shortcut">Object Hierarchy</a> + | + <a href="#NMSettingSerial.properties" class="shortcut">Properties</a> +</td></tr> +</table> +<div class="refentry"> +<a name="NMSettingSerial"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="NMSettingSerial.top_of_page"></a>NMSettingSerial</span></h2> +<p>NMSettingSerial — Describes connection properties for devices that use +serial communications</p> +</td> +<td valign="top" align="right"></td> +</tr></table></div> +<div class="refsynopsisdiv"> +<a name="NMSettingSerial.synopsis"></a><h2>Synopsis</h2> +<a name="NMSettingSerialParity"></a><pre class="synopsis">#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-SETTING-NAME:CAPS" title="NM_SETTING_SERIAL_SETTING_NAME">NM_SETTING_SERIAL_SETTING_NAME</a> +enum <a class="link" href="NMSettingSerial.html#NMSettingSerialParity-enum" title="enum NMSettingSerialParity">NMSettingSerialParity</a>; +#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-BAUD:CAPS" title="NM_SETTING_SERIAL_BAUD">NM_SETTING_SERIAL_BAUD</a> +#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-BITS:CAPS" title="NM_SETTING_SERIAL_BITS">NM_SETTING_SERIAL_BITS</a> +#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-PARITY:CAPS" title="NM_SETTING_SERIAL_PARITY">NM_SETTING_SERIAL_PARITY</a> +#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-STOPBITS:CAPS" title="NM_SETTING_SERIAL_STOPBITS">NM_SETTING_SERIAL_STOPBITS</a> +#define <a class="link" href="NMSettingSerial.html#NM-SETTING-SERIAL-SEND-DELAY:CAPS" title="NM_SETTING_SERIAL_SEND_DELAY">NM_SETTING_SERIAL_SEND_DELAY</a> +struct <a class="link" href="NMSettingSerial.html#NMSettingSerial-struct" title="struct NMSettingSerial">NMSettingSerial</a>; + <a class="link" href="NMSettingSerial.html#NMSettingSerialClass" title="NMSettingSerialClass">NMSettingSerialClass</a>; +<a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * <a class="link" href="NMSettingSerial.html#nm-setting-serial-new" title="nm_setting_serial_new ()">nm_setting_serial_new</a> (<em class="parameter"><code><span class="type">void</span></code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="NMSettingSerial.html#nm-setting-serial-get-baud" title="nm_setting_serial_get_baud ()">nm_setting_serial_get_baud</a> (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="NMSettingSerial.html#nm-setting-serial-get-bits" title="nm_setting_serial_get_bits ()">nm_setting_serial_get_bits</a> (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>); +<a class="link" href="NMSettingSerial.html#NMSettingSerialParity"><span class="returnvalue">NMSettingSerialParity</span></a> <a class="link" href="NMSettingSerial.html#nm-setting-serial-get-parity" title="nm_setting_serial_get_parity ()">nm_setting_serial_get_parity</a> (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> <a class="link" href="NMSettingSerial.html#nm-setting-serial-get-stopbits" title="nm_setting_serial_get_stopbits ()">nm_setting_serial_get_stopbits</a> (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>); +<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> <a class="link" href="NMSettingSerial.html#nm-setting-serial-get-send-delay" title="nm_setting_serial_get_send_delay ()">nm_setting_serial_get_send_delay</a> (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>); +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingSerial.object-hierarchy"></a><h2>Object Hierarchy</h2> +<pre class="synopsis"> + GEnum + +----NMSettingSerialParity +</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="NMSetting.html" title="NMSetting">NMSetting</a> + +----NMSettingSerial +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingSerial.properties"></a><h2>Properties</h2> +<pre class="synopsis"> + "<a class="link" href="NMSettingSerial.html#NMSettingSerial--baud" title='The "baud" property'>baud</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct + "<a class="link" href="NMSettingSerial.html#NMSettingSerial--bits" title='The "bits" property'>bits</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct + "<a class="link" href="NMSettingSerial.html#NMSettingSerial--parity" title='The "parity" property'>parity</a>" <a class="link" href="NMSettingSerial.html#NMSettingSerialParity"><span class="type">NMSettingSerialParity</span></a> : Read / Write / Construct + "<a class="link" href="NMSettingSerial.html#NMSettingSerial--send-delay" title='The "send-delay" property'>send-delay</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write / Construct + "<a class="link" href="NMSettingSerial.html#NMSettingSerial--stopbits" title='The "stopbits" property'>stopbits</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct +</pre> +</div> +<div class="refsect1"> +<a name="NMSettingSerial.description"></a><h2>Description</h2> +<p> +The <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object is a <a class="link" href="NMSetting.html" title="NMSetting"><span class="type">NMSetting</span></a> subclass that describes +properties necessary for connections that may use serial communications, +such as mobile broadband or analog telephone connections. +</p> +</div> +<div class="refsect1"> +<a name="NMSettingSerial.details"></a><h2>Details</h2> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-SETTING-NAME:CAPS"></a><h3>NM_SETTING_SERIAL_SETTING_NAME</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_SETTING_NAME "serial" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerialParity-enum"></a><h3>enum NMSettingSerialParity</h3> +<pre class="programlisting">typedef enum { + NM_SETTING_SERIAL_PARITY_NONE = 0, + NM_SETTING_SERIAL_PARITY_EVEN, + NM_SETTING_SERIAL_PARITY_ODD +} NMSettingSerialParity; +</pre> +<p> +The parity setting of a serial port. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><a name="NM-SETTING-SERIAL-PARITY-NONE:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_PARITY_NONE</code></span></p></td> +<td>No parity bits (default) +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-SERIAL-PARITY-EVEN:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_PARITY_EVEN</code></span></p></td> +<td>Even parity +</td> +</tr> +<tr> +<td><p><a name="NM-SETTING-SERIAL-PARITY-ODD:CAPS"></a><span class="term"><code class="literal">NM_SETTING_SERIAL_PARITY_ODD</code></span></p></td> +<td>Odd parity +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-BAUD:CAPS"></a><h3>NM_SETTING_SERIAL_BAUD</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_BAUD "baud" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-BITS:CAPS"></a><h3>NM_SETTING_SERIAL_BITS</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_BITS "bits" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-PARITY:CAPS"></a><h3>NM_SETTING_SERIAL_PARITY</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_PARITY "parity" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-STOPBITS:CAPS"></a><h3>NM_SETTING_SERIAL_STOPBITS</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_STOPBITS "stopbits" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NM-SETTING-SERIAL-SEND-DELAY:CAPS"></a><h3>NM_SETTING_SERIAL_SEND_DELAY</h3> +<pre class="programlisting">#define NM_SETTING_SERIAL_SEND_DELAY "send-delay" +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerial-struct"></a><h3>struct NMSettingSerial</h3> +<pre class="programlisting">struct NMSettingSerial;</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerialClass"></a><h3>NMSettingSerialClass</h3> +<pre class="programlisting">typedef struct { + NMSettingClass parent; +} NMSettingSerialClass; +</pre> +<p> +</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-new"></a><h3>nm_setting_serial_new ()</h3> +<pre class="programlisting"><a class="link" href="NMSetting.html" title="NMSetting"><span class="returnvalue">NMSetting</span></a> * nm_setting_serial_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p> +Creates a new <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object with default values. +</p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody><tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the new empty <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> object. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span> +</td> +</tr></tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-get-baud"></a><h3>nm_setting_serial_get_baud ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_baud (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html#NMSettingSerial--baud" title='The "baud" property'><span class="type">"baud"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-get-bits"></a><h3>nm_setting_serial_get_bits ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_bits (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html#NMSettingSerial--bits" title='The "bits" property'><span class="type">"bits"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-get-parity"></a><h3>nm_setting_serial_get_parity ()</h3> +<pre class="programlisting"><a class="link" href="NMSettingSerial.html#NMSettingSerialParity"><span class="returnvalue">NMSettingSerialParity</span></a> nm_setting_serial_get_parity (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html#NMSettingSerial--parity" title='The "parity" property'><span class="type">"parity"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-get-stopbits"></a><h3>nm_setting_serial_get_stopbits ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="returnvalue">guint</span></a> nm_setting_serial_get_stopbits (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html#NMSettingSerial--stopbits" title='The "stopbits" property'><span class="type">"stopbits"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="nm-setting-serial-get-send-delay"></a><h3>nm_setting_serial_get_send_delay ()</h3> +<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="returnvalue">guint64</span></a> nm_setting_serial_get_send_delay (<em class="parameter"><code><a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> *setting</code></em>);</pre> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><em class="parameter"><code>setting</code></em> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html" title="NMSettingSerial"><span class="type">NMSettingSerial</span></a> +</td> +</tr> +<tr> +<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td> +<td>the <a class="link" href="NMSettingSerial.html#NMSettingSerial--send-delay" title='The "send-delay" property'><span class="type">"send-delay"</span></a> property of the setting</td> +</tr> +</tbody> +</table></div> +</div> +</div> +<div class="refsect1"> +<a name="NMSettingSerial.property-details"></a><h2>Property Details</h2> +<div class="refsect2"> +<a name="NMSettingSerial--baud"></a><h3>The <code class="literal">"baud"</code> property</h3> +<pre class="programlisting"> "baud" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> +<p> +Speed to use for communication over the serial port. Note that this +value usually has no effect for mobile broadband modems as they generally +ignore speed settings and use the highest available speed. +</p> +<p>Default value: 57600</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerial--bits"></a><h3>The <code class="literal">"bits"</code> property</h3> +<pre class="programlisting"> "bits" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> +<p> +Byte-width of the serial communication. The 8 in "8n1" for example. +</p> +<p>Allowed values: [5,8]</p> +<p>Default value: 8</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerial--parity"></a><h3>The <code class="literal">"parity"</code> property</h3> +<pre class="programlisting"> "parity" <a class="link" href="NMSettingSerial.html#NMSettingSerialParity"><span class="type">NMSettingSerialParity</span></a> : Read / Write / Construct</pre> +<p> +Parity setting of the serial port. +</p> +<p>Default value: NM_SETTING_SERIAL_PARITY_NONE</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerial--send-delay"></a><h3>The <code class="literal">"send-delay"</code> property</h3> +<pre class="programlisting"> "send-delay" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a> : Read / Write / Construct</pre> +<p> +Time to delay between each byte sent to the modem, in microseconds. +</p> +<p>Default value: 0</p> +</div> +<hr> +<div class="refsect2"> +<a name="NMSettingSerial--stopbits"></a><h3>The <code class="literal">"stopbits"</code> property</h3> +<pre class="programlisting"> "stopbits" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write / Construct</pre> +<p> +Number of stop bits for communication on the serial port. Either 1 or 2. +The 1 in "8n1" for example. +</p> +<p>Allowed values: [1,2]</p> +<p>Default value: 1</p> +</div> +</div> +</div> +<div class="footer"> +<hr> + Generated by GTK-Doc V1.19</div> +</body> +</html> \ No newline at end of file |