Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > os > by-pkgid > 9c481c872fb0ae0cbadccdc2f4a18ab6 > files > 115

libasync-devel-0.17.0-5.fc14.x86_64.rpm

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Async: AsyncSerial.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
  <div class="tabs">
    <ul>
      <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li><a href="dirs.html"><span>Directories</span></a></li>
      <li><a href="examples.html"><span>Examples</span></a></li>
    </ul>
  </div>
  <div class="tabs">
    <ul>
      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
    </ul>
  </div>
  <div class="navpath"><a class="el" href="dir_d583404e3b046262ade615a4e7154c3b.html">include</a>
  </div>
</div>
<div class="contents">
<h1>AsyncSerial.h</h1><a href="AsyncSerial_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef SERIAL_INCLUDED</span>
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define SERIAL_INCLUDED</span>
<a name="l00037"></a>00037 <span class="preprocessor"></span>
<a name="l00038"></a>00038 
<a name="l00039"></a>00039 <span class="comment">/****************************************************************************</span>
<a name="l00040"></a>00040 <span class="comment"> *</span>
<a name="l00041"></a>00041 <span class="comment"> * System Includes</span>
<a name="l00042"></a>00042 <span class="comment"> *</span>
<a name="l00043"></a>00043 <span class="comment"> ****************************************************************************/</span>
<a name="l00044"></a>00044 
<a name="l00045"></a>00045 <span class="preprocessor">#include &lt;sigc++/sigc++.h&gt;</span>
<a name="l00046"></a>00046 <span class="preprocessor">#include &lt;termios.h&gt;</span>
<a name="l00047"></a>00047 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
<a name="l00048"></a>00048 
<a name="l00049"></a>00049 <span class="preprocessor">#include &lt;string&gt;</span>
<a name="l00050"></a>00050 
<a name="l00051"></a>00051 
<a name="l00052"></a>00052 <span class="comment">/****************************************************************************</span>
<a name="l00053"></a>00053 <span class="comment"> *</span>
<a name="l00054"></a>00054 <span class="comment"> * Project Includes</span>
<a name="l00055"></a>00055 <span class="comment"> *</span>
<a name="l00056"></a>00056 <span class="comment"> ****************************************************************************/</span>
<a name="l00057"></a>00057 
<a name="l00058"></a>00058 
<a name="l00059"></a>00059 
<a name="l00060"></a>00060 <span class="comment">/****************************************************************************</span>
<a name="l00061"></a>00061 <span class="comment"> *</span>
<a name="l00062"></a>00062 <span class="comment"> * Local Includes</span>
<a name="l00063"></a>00063 <span class="comment"> *</span>
<a name="l00064"></a>00064 <span class="comment"> ****************************************************************************/</span>
<a name="l00065"></a>00065 
<a name="l00066"></a>00066 
<a name="l00067"></a>00067 
<a name="l00068"></a>00068 <span class="comment">/****************************************************************************</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * Forward declarations</span>
<a name="l00071"></a>00071 <span class="comment"> *</span>
<a name="l00072"></a>00072 <span class="comment"> ****************************************************************************/</span>
<a name="l00073"></a>00073 
<a name="l00074"></a>00074 
<a name="l00075"></a>00075 
<a name="l00076"></a>00076 <span class="comment">/****************************************************************************</span>
<a name="l00077"></a>00077 <span class="comment"> *</span>
<a name="l00078"></a>00078 <span class="comment"> * Namespace</span>
<a name="l00079"></a>00079 <span class="comment"> *</span>
<a name="l00080"></a>00080 <span class="comment"> ****************************************************************************/</span>
<a name="l00081"></a>00081 
<a name="l00082"></a>00082 <span class="keyword">namespace </span>Async
<a name="l00083"></a>00083 {
<a name="l00084"></a>00084 
<a name="l00085"></a>00085 
<a name="l00086"></a>00086 <span class="comment">/****************************************************************************</span>
<a name="l00087"></a>00087 <span class="comment"> *</span>
<a name="l00088"></a>00088 <span class="comment"> * Forward declarations of classes inside of the declared namespace</span>
<a name="l00089"></a>00089 <span class="comment"> *</span>
<a name="l00090"></a>00090 <span class="comment"> ****************************************************************************/</span>
<a name="l00091"></a>00091 
<a name="l00092"></a>00092 <span class="keyword">class </span>FdWatch;
<a name="l00093"></a>00093 <span class="keyword">class </span>SerialDevice;
<a name="l00094"></a>00094   
<a name="l00095"></a>00095 
<a name="l00096"></a>00096 <span class="comment">/****************************************************************************</span>
<a name="l00097"></a>00097 <span class="comment"> *</span>
<a name="l00098"></a>00098 <span class="comment"> * Defines &amp; typedefs</span>
<a name="l00099"></a>00099 <span class="comment"> *</span>
<a name="l00100"></a>00100 <span class="comment"> ****************************************************************************/</span>
<a name="l00101"></a>00101 
<a name="l00102"></a>00102 
<a name="l00103"></a>00103 
<a name="l00104"></a>00104 <span class="comment">/****************************************************************************</span>
<a name="l00105"></a>00105 <span class="comment"> *</span>
<a name="l00106"></a>00106 <span class="comment"> * Exported Global Variables</span>
<a name="l00107"></a>00107 <span class="comment"> *</span>
<a name="l00108"></a>00108 <span class="comment"> ****************************************************************************/</span>
<a name="l00109"></a>00109 
<a name="l00110"></a>00110 
<a name="l00111"></a>00111 
<a name="l00112"></a>00112 <span class="comment">/****************************************************************************</span>
<a name="l00113"></a>00113 <span class="comment"> *</span>
<a name="l00114"></a>00114 <span class="comment"> * Class definitions</span>
<a name="l00115"></a>00115 <span class="comment"> *</span>
<a name="l00116"></a>00116 <span class="comment"> ****************************************************************************/</span>
<a name="l00117"></a>00117 
<a name="l00129"></a><a class="code" href="classAsync_1_1Serial.html">00129</a> <span class="keyword">class </span><a class="code" href="classAsync_1_1Serial.html" title="A class for using asyncronous serial communications.">Serial</a> : <span class="keyword">public</span> SigC::Object
<a name="l00130"></a>00130 {
<a name="l00131"></a>00131   <span class="keyword">public</span>:
<a name="l00135"></a><a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bc">00135</a>     <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00136"></a>00136     {
<a name="l00137"></a><a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bca5da2349db85b90a230c03abed17a8a81">00137</a>       <a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bca5da2349db85b90a230c03abed17a8a81" title="Parity not used.">PARITY_NONE</a>,  
<a name="l00138"></a><a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bcaec3161f64c3e8020b0ecd6df1d4fa967">00138</a>       <a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bcaec3161f64c3e8020b0ecd6df1d4fa967" title="Use even parity.">PARITY_EVEN</a>,  
<a name="l00139"></a><a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bca52cd62c3e3c8c7165161838f5538e67d">00139</a>       <a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bca52cd62c3e3c8c7165161838f5538e67d" title="Use odd parity.">PARITY_ODD</a>    
<a name="l00140"></a>00140     } <a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bc" title="A type that defines the possible choices for parity.">Parity</a>;
<a name="l00141"></a>00141 
<a name="l00145"></a><a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61">00145</a>     <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00146"></a>00146     {
<a name="l00147"></a><a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a47021b4d27b5bdd8ddee3213fe2465ec">00147</a>       <a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a47021b4d27b5bdd8ddee3213fe2465ec" title="No flow control in use.">FLOW_NONE</a>,    
<a name="l00148"></a><a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a58c7397ce4fde9fd1dffa7bb836367ea">00148</a>       <a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a58c7397ce4fde9fd1dffa7bb836367ea" title="Use hardware flow control.">FLOW_HW</a>,      
<a name="l00149"></a><a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a5c4f3f4d69a8ae429f06e0ede422b493">00149</a>       <a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61a5c4f3f4d69a8ae429f06e0ede422b493" title="Use software (XON/XOFF) flow control.">FLOW_XONOFF</a>   
<a name="l00150"></a>00150     } <a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61" title="A type that defines the possible choices for flow control.">Flow</a>;
<a name="l00151"></a>00151     
<a name="l00155"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47d">00155</a>     <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00156"></a>00156     {
<a name="l00157"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da78585281bc6a0c7defed062e6cf2649e">00157</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da78585281bc6a0c7defed062e6cf2649e" title="No pin.">PIN_NONE</a>, 
<a name="l00158"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dad7717ebce686a14d774a2ddd9c9cc151">00158</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dad7717ebce686a14d774a2ddd9c9cc151" title="Output: Request To Send.">PIN_RTS</a>,  
<a name="l00159"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da2c81e31ec783d57ce5dc0daf250fdaf3">00159</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da2c81e31ec783d57ce5dc0daf250fdaf3" title="Output: Data Terminal Ready.">PIN_DTR</a>,  
<a name="l00160"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da83969c7df7485ffb91493bb17ced04ab">00160</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da83969c7df7485ffb91493bb17ced04ab" title="Input: Clear To Send.">PIN_CTS</a>,  
<a name="l00161"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dafbcef9b6945727705f58811271b12893">00161</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dafbcef9b6945727705f58811271b12893" title="Input: Data Set Ready.">PIN_DSR</a>,  
<a name="l00162"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da8ccddd9b43649cab174b86792a4d7776">00162</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47da8ccddd9b43649cab174b86792a4d7776" title="Input: Data Carrier Detect.">PIN_DCD</a>,  
<a name="l00163"></a><a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dacd7d556f45c9e2fbaced114e01a37c23">00163</a>       <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47dacd7d556f45c9e2fbaced114e01a37c23" title="Input: Ring Indicate.">PIN_RI</a>    
<a name="l00164"></a>00164     } <a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47d" title="A type that defines the read/write pins in the serial port.">Pin</a>;
<a name="l00165"></a>00165     
<a name="l00169"></a><a class="code" href="classAsync_1_1Serial.html#a8597654759f1ff16d7528f2280b8e2d0">00169</a>     <span class="keyword">static</span> <span class="keyword">const</span> <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1Serial.html#a8597654759f1ff16d7528f2280b8e2d0" title="The maximum number of characters that can be read at once.">READ_BUFSIZE</a> = 1024;
<a name="l00170"></a>00170         
<a name="l00171"></a>00171 
<a name="l00181"></a>00181     <span class="keyword">explicit</span> <a class="code" href="classAsync_1_1Serial.html#a1e028dd2da210ecfa36cd385827877a1" title="Constuctor.">Serial</a>(<span class="keyword">const</span> std::string&amp; serial_port);
<a name="l00182"></a>00182   
<a name="l00186"></a>00186     <a class="code" href="classAsync_1_1Serial.html#a61e0316947bd97cb072d39781c9b10df" title="Destructor.">~Serial</a>(<span class="keywordtype">void</span>);
<a name="l00187"></a>00187     
<a name="l00204"></a>00204     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#a45989c15c443d6e776230645751ccc73" title="Setup the serial port communications parameters.">setParams</a>(<span class="keywordtype">int</span> speed, <a class="code" href="classAsync_1_1Serial.html#a7428061313a2989bce6355b0207728bc" title="A type that defines the possible choices for parity.">Parity</a> parity, <span class="keywordtype">int</span> bits, <span class="keywordtype">int</span> stop_bits,
<a name="l00205"></a>00205                    <a class="code" href="classAsync_1_1Serial.html#a10c109663cbee56341bb70863e598a61" title="A type that defines the possible choices for flow control.">Flow</a> flow);
<a name="l00206"></a>00206     
<a name="l00220"></a>00220     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#ae6abc206c1ce20e231eb8823efe14b3d" title="Open the serial port.">open</a>(<span class="keywordtype">void</span>);
<a name="l00221"></a>00221     
<a name="l00233"></a>00233     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#a4b23c3541564680c21944e23c95df56f" title="Close a previously opened serial port.">close</a>(<span class="keywordtype">void</span>);
<a name="l00234"></a>00234     
<a name="l00243"></a><a class="code" href="classAsync_1_1Serial.html#a6be9ecfdb9dcd22b1be0c52597504143">00243</a>     <span class="keywordtype">int</span> <a class="code" href="classAsync_1_1Serial.html#a6be9ecfdb9dcd22b1be0c52597504143" title="Write data to the serial port.">write</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *buf, <span class="keywordtype">size_t</span> count)
<a name="l00244"></a>00244     {
<a name="l00245"></a>00245       <a class="code" href="classAsync_1_1Serial.html#a6be9ecfdb9dcd22b1be0c52597504143" title="Write data to the serial port.">return ::write</a>(fd, buf, count);
<a name="l00246"></a>00246     }
<a name="l00247"></a>00247 
<a name="l00264"></a>00264     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#aa69ca8e6f61f5590f587bcc1b93b0c27" title="Set or clear canonical mode.">setCanonical</a>(<span class="keywordtype">bool</span> canonical);
<a name="l00265"></a>00265     
<a name="l00276"></a>00276     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#a97fa0a47aba962dea2f679e731ff9323" title="Stop/start input of data.">stopInput</a>(<span class="keywordtype">bool</span> stop);
<a name="l00277"></a>00277 
<a name="l00289"></a>00289     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#a7ae847ef7d132141d91b1badb2703ea1" title="Set the state of one of the output pins in the serial port.">setPin</a>(<a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47d" title="A type that defines the read/write pins in the serial port.">Pin</a> pin, <span class="keywordtype">bool</span> <span class="keyword">set</span>);
<a name="l00290"></a>00290     
<a name="l00302"></a>00302     <span class="keywordtype">bool</span> <a class="code" href="classAsync_1_1Serial.html#ae22eede9f8ad93081b1d2871bb92f32d" title="Get the state of one of the input pins in the serial port.">getPin</a>(<a class="code" href="classAsync_1_1Serial.html#a659f4cc316ddf7517927f7ee61d0c47d" title="A type that defines the read/write pins in the serial port.">Pin</a> pin, <span class="keywordtype">bool</span> &amp;is_set);
<a name="l00303"></a>00303 
<a name="l00314"></a><a class="code" href="classAsync_1_1Serial.html#a354b99acfd0c1390889b8d868ae35c5a">00314</a>     SigC::Signal2&lt;void, char*, int&gt; <a class="code" href="classAsync_1_1Serial.html#a354b99acfd0c1390889b8d868ae35c5a" title="A signal that is emitted when there is data to read.">charactersReceived</a>;
<a name="l00315"></a>00315     
<a name="l00316"></a>00316       
<a name="l00317"></a>00317   <span class="keyword">protected</span>:
<a name="l00318"></a>00318     
<a name="l00319"></a>00319   <span class="keyword">private</span>:    
<a name="l00320"></a>00320     <span class="keyword">const</span> std::string   serial_port;
<a name="l00321"></a>00321     <span class="keywordtype">bool</span>                canonical;
<a name="l00322"></a>00322     
<a name="l00323"></a>00323     <span class="keywordtype">int</span>                 fd;
<a name="l00324"></a>00324     <span class="keyword">struct </span>termios      port_settings;
<a name="l00325"></a>00325     SerialDevice        *dev;
<a name="l00326"></a>00326     
<a name="l00327"></a>00327 
<a name="l00328"></a>00328 };  <span class="comment">/* class Serial */</span>
<a name="l00329"></a>00329 
<a name="l00330"></a>00330 
<a name="l00331"></a>00331 } <span class="comment">/* namespace */</span>
<a name="l00332"></a>00332 
<a name="l00333"></a>00333 <span class="preprocessor">#endif </span><span class="comment">/* SERIAL_INCLUDED */</span>
<a name="l00334"></a>00334 
<a name="l00335"></a>00335 
<a name="l00336"></a>00336 
<a name="l00337"></a>00337 <span class="comment">/*</span>
<a name="l00338"></a>00338 <span class="comment"> * This file has not been truncated</span>
<a name="l00339"></a>00339 <span class="comment"> */</span>
<a name="l00340"></a>00340 
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional