Myth/serial
1
0
Fork 0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 11:44:53 +08:00
Code Issues Projects Releases Wiki Activity
serial/doc/1.0.1/win_8h_source.html
William Woodall 756dec9a1e Uploading documentation for version 1.1.0
2012-10-24 00:15:53 -07:00

269 lines
20 KiB
HTML
Raw Blame History

<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>serial: include/serial/impl/win.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">serial
&#160;<span id="projectnumber">1.0.1</span>
</div>
<div id="projectbrief">Cross-platform serial port library written in C++</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">include/serial/impl/win.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="win_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001
<a name="l00037"></a>00037 <span class="preprocessor">#ifndef SERIAL_IMPL_WINDOWS_H</span>
<a name="l00038"></a>00038 <span class="preprocessor"></span><span class="preprocessor">#define SERIAL_IMPL_WINDOWS_H</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span>
<a name="l00040"></a>00040 <span class="preprocessor">#include &quot;<a class="code" href="serial_8h.html">serial/serial.h</a>&quot;</span>
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#include &quot;windows.h&quot;</span>
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keyword">namespace </span>serial {
<a name="l00045"></a>00045
<a name="l00046"></a>00046 <span class="keyword">using</span> std::string;
<a name="l00047"></a>00047 <span class="keyword">using</span> std::invalid_argument;
<a name="l00048"></a>00048
<a name="l00049"></a>00049 <span class="keyword">using</span> <a class="code" href="classserial_1_1_serial_execption.html">serial::SerialExecption</a>;
<a name="l00050"></a>00050 <span class="keyword">using</span> <a class="code" href="classserial_1_1_i_o_exception.html">serial::IOException</a>;
<a name="l00051"></a>00051
<a name="l00052"></a>00052 <span class="keyword">class </span>serial::Serial::SerialImpl {
<a name="l00053"></a>00053 <span class="keyword">public</span>:
<a name="l00054"></a>00054 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a9baa5dccbb7935163bf6715eb5d9deff">SerialImpl</a> (<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;port,
<a name="l00055"></a>00055 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate,
<a name="l00056"></a>00056 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize,
<a name="l00057"></a>00057 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity,
<a name="l00058"></a>00058 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits,
<a name="l00059"></a>00059 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="keyword">virtual</span> <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a7972685753e76e0068b754601442a8a5">~SerialImpl</a> ();
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="keywordtype">void</span>
<a name="l00064"></a>00064 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#abc447d3fefa173392f5d7b641ffef1ed">open</a> ();
<a name="l00065"></a>00065
<a name="l00066"></a>00066 <span class="keywordtype">void</span>
<a name="l00067"></a>00067 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a38af5b9c8b676ffaef15c84fb303d6f7">close</a> ();
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="keywordtype">bool</span>
<a name="l00070"></a>00070 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a189fe759d2119a6513d5981575a91b8e">isOpen</a> () <span class="keyword">const</span>;
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="keywordtype">size_t</span>
<a name="l00073"></a>00073 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aec474ec54cb40a4191939aacb80c5ea2">available</a> ();
<a name="l00074"></a>00074
<a name="l00075"></a>00075 <span class="keywordtype">size_t</span>
<a name="l00076"></a>00076 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa72d6878e104a7fa7a5a635787c4f439">read</a> (uint8_t *buf, <span class="keywordtype">size_t</span> size = 1);
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keywordtype">size_t</span>
<a name="l00079"></a>00079 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a222136f14876f84fd0d95f47a7d9c541">write</a> (<span class="keyword">const</span> uint8_t *data, <span class="keywordtype">size_t</span> length);
<a name="l00080"></a>00080
<a name="l00081"></a>00081 <span class="keywordtype">void</span>
<a name="l00082"></a>00082 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a7dc1818234ab3f5ae3ebd67bc79d8511">flush</a> ();
<a name="l00083"></a>00083
<a name="l00084"></a>00084 <span class="keywordtype">void</span>
<a name="l00085"></a>00085 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a28003745a26c0924fc1d305e947bc3bf">flushInput</a> ();
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordtype">void</span>
<a name="l00088"></a>00088 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a5b2c81540ca1e1eb962249ca8f538299">flushOutput</a> ();
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <span class="keywordtype">void</span>
<a name="l00091"></a>00091 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a3f738264b8236e271d79835f0ec08bf3">sendBreak</a> (<span class="keywordtype">int</span> duration);
<a name="l00092"></a>00092
<a name="l00093"></a>00093 <span class="keywordtype">void</span>
<a name="l00094"></a>00094 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aff11802f071e95c0e88ef6d0fa3bacd7">setBreak</a> (<span class="keywordtype">bool</span> level);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordtype">void</span>
<a name="l00097"></a>00097 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa6f543e9fb4517fa00835eee15fa5ffa">setRTS</a> (<span class="keywordtype">bool</span> level);
<a name="l00098"></a>00098
<a name="l00099"></a>00099 <span class="keywordtype">void</span>
<a name="l00100"></a>00100 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a741dbda555f51bb7be361a602f72358c">setDTR</a> (<span class="keywordtype">bool</span> level);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keywordtype">bool</span>
<a name="l00103"></a>00103 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#abf091b468bdc0d9d338e51e746e0c397">waitForChange</a> ();
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordtype">bool</span>
<a name="l00106"></a>00106 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a0801d20b6e906369ad232e460b741d7b">getCTS</a> ();
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="keywordtype">bool</span>
<a name="l00109"></a>00109 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a15d1d986dad6ec754919bb38c3470362">getDSR</a> ();
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keywordtype">bool</span>
<a name="l00112"></a>00112 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a0ee5f4cd897bc177a179ec4f0ba8c561">getRI</a> ();
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keywordtype">bool</span>
<a name="l00115"></a>00115 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a6f2a8d7ff955fc3f061b513c095859e1">getCD</a> ();
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keywordtype">void</span>
<a name="l00118"></a>00118 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aeb3006e2ff05d5bbaa518bb788eebcda">setPort</a> (<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;port);
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="keywordtype">string</span>
<a name="l00121"></a>00121 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a1f881c2cf8bfc92a7836ee0dd554ec44">getPort</a> () <span class="keyword">const</span>;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordtype">void</span>
<a name="l00124"></a>00124 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a18365f4a89637103fafb16bc97b8ec2c">setTimeout</a> (Timeout &amp;timeout);
<a name="l00125"></a>00125
<a name="l00126"></a>00126 Timeout
<a name="l00127"></a>00127 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a3523fd0100ba27787042b257cb1b3e63">getTimeout</a> () <span class="keyword">const</span>;
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="keywordtype">void</span>
<a name="l00130"></a>00130 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a9773deb112bc756a7512930ec4bf23b3">setBaudrate</a> (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate);
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span>
<a name="l00133"></a>00133 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af04d2d662a302d446bf8a99151e7a229">getBaudrate</a> () <span class="keyword">const</span>;
<a name="l00134"></a>00134
<a name="l00135"></a>00135 <span class="keywordtype">void</span>
<a name="l00136"></a>00136 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ac7bde1547ae13c2bbb09126ae7082661">setBytesize</a> (<a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize);
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a>
<a name="l00139"></a>00139 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aafeff74e9aed67a996735dbb46323b25">getBytesize</a> () <span class="keyword">const</span>;
<a name="l00140"></a>00140
<a name="l00141"></a>00141 <span class="keywordtype">void</span>
<a name="l00142"></a>00142 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a2619123d52d075967bdb35247f40e51b">setParity</a> (<a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity);
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a>
<a name="l00145"></a>00145 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#aa7cc3b7bd62ad98d25f2e2e0f27d3b42">getParity</a> () <span class="keyword">const</span>;
<a name="l00146"></a>00146
<a name="l00147"></a>00147 <span class="keywordtype">void</span>
<a name="l00148"></a>00148 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a697da32867459d1c4e527c3ec468062e">setStopbits</a> (<a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits);
<a name="l00149"></a>00149
<a name="l00150"></a>00150 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a>
<a name="l00151"></a>00151 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af52b7b4b1d78b9fc98f7150587ddc8b6">getStopbits</a> () <span class="keyword">const</span>;
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="keywordtype">void</span>
<a name="l00154"></a>00154 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a70f3aaa863c4d11c226a983377a37e43">setFlowcontrol</a> (<a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol);
<a name="l00155"></a>00155
<a name="l00156"></a>00156 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a>
<a name="l00157"></a>00157 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#af1b3fe4ea4d075b76b0c243d4ed768ec">getFlowcontrol</a> () <span class="keyword">const</span>;
<a name="l00158"></a>00158
<a name="l00159"></a>00159 <span class="keywordtype">void</span>
<a name="l00160"></a>00160 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a3536cdcf1a389a2effe27455db31b906">readLock</a> ();
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keywordtype">void</span>
<a name="l00163"></a>00163 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a63f05143ebfa94168e1df5047362ef0e">readUnlock</a> ();
<a name="l00164"></a>00164
<a name="l00165"></a>00165 <span class="keywordtype">void</span>
<a name="l00166"></a>00166 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#ac094e8cb4a5957e1ddeb1d4fdc9d9536">writeLock</a> ();
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keywordtype">void</span>
<a name="l00169"></a>00169 <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#afeac86484622bbeb08303e98db24efe0">writeUnlock</a> ();
<a name="l00170"></a>00170
<a name="l00171"></a>00171 <span class="keyword">protected</span>:
<a name="l00172"></a>00172 <span class="keywordtype">void</span> <a class="code" href="classserial_1_1serial_1_1_serial_1_1_serial_impl.html#a48dcc5d2568edd1ce29df30a95d460d9">reconfigurePort</a> ();
<a name="l00173"></a>00173
<a name="l00174"></a>00174 <span class="keyword">private</span>:
<a name="l00175"></a>00175 <span class="keywordtype">string</span> port_; <span class="comment">// Path to the file descriptor</span>
<a name="l00176"></a>00176 HANDLE fd_;
<a name="l00177"></a>00177
<a name="l00178"></a>00178 <span class="keywordtype">bool</span> is_open_;
<a name="l00179"></a>00179
<a name="l00180"></a>00180 Timeout timeout_; <span class="comment">// Timeout for read operations</span>
<a name="l00181"></a>00181 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> baudrate_; <span class="comment">// Baudrate</span>
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <a class="code" href="namespaceserial.html#a8f45d26bf7c9a06659e75b5004a50481">parity_t</a> parity_; <span class="comment">// Parity</span>
<a name="l00184"></a>00184 <a class="code" href="namespaceserial.html#a00b3281fa11cea770c0b0c8a106080f8">bytesize_t</a> bytesize_; <span class="comment">// Size of the bytes</span>
<a name="l00185"></a>00185 <a class="code" href="namespaceserial.html#af5b116611d6628a3aa8f788fdc09f469">stopbits_t</a> stopbits_; <span class="comment">// Stop Bits</span>
<a name="l00186"></a>00186 <a class="code" href="namespaceserial.html#a93ef57a314b4e562f9eded6c15d34351">flowcontrol_t</a> flowcontrol_; <span class="comment">// Flow Control</span>
<a name="l00187"></a>00187
<a name="l00188"></a>00188 <span class="comment">// Mutex used to lock the read functions</span>
<a name="l00189"></a>00189 HANDLE read_mutex;
<a name="l00190"></a>00190 <span class="comment">// Mutex used to lock the write functions</span>
<a name="l00191"></a>00191 HANDLE write_mutex;
<a name="l00192"></a>00192 };
<a name="l00193"></a>00193
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195
<a name="l00196"></a>00196 <span class="preprocessor">#endif // SERIAL_IMPL_WINDOWS_H</span>
</pre></div></div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Aug 27 2012 11:36:46 for serial by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink