Myth/serial
1
0
Fork 0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 19:54:57 +08:00
Code Issues Projects Releases Wiki Activity
serial/docs/v1.0/structserial_1_1timeout__t.html
William Woodall 4ea212b0cd Adding proposed v1.0 api to gh-pages
2012-05-02 00:40:56 -05:00

260 lines
12 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: serial::timeout_t Struct Reference</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</span>
</div>
<div id="projectbrief">Cross-platform serial port library for 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 class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><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="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceserial.html">serial</a> </li>
<li class="navelem"><a class="el" href="structserial_1_1timeout__t.html">timeout_t</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">serial::timeout_t Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#include &lt;<a class="el" href="serial_8h_source.html">serial.h</a>&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a66a9f8ddc185a5c94b95fa2b0b7e6fbc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#a66a9f8ddc185a5c94b95fa2b0b7e6fbc">timeout_t</a> (long inter_byte_timeout_=0, long read_timeout_constant_=0, long read_timeout_multiplier_=0, long write_timeout_constant_=0, long write_timeout_multiplier_=0)</td></tr>
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:abb885cffadb5ee57c6689d5a3c50dfad"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">inter_byte_timeout</a></td></tr>
<tr class="memitem:a2fc1dbde1ba635636379085f4e5f58fe"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">read_timeout_constant</a></td></tr>
<tr class="memitem:a548b76a924a2f8d5c902130cb587e6bb"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">read_timeout_multiplier</a></td></tr>
<tr class="memitem:acd6e36245118512785400915828cfd32"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">write_timeout_constant</a></td></tr>
<tr class="memitem:af43380c4255a9b8669970532048c4dfc"><td class="memItemLeft" align="right" valign="top">long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">write_timeout_multiplier</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Structure for setting the timeout of the serial port, times are in milliseconds. </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a66a9f8ddc185a5c94b95fa2b0b7e6fbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="structserial_1_1timeout__t.html#a66a9f8ddc185a5c94b95fa2b0b7e6fbc">serial::timeout_t::timeout_t</a> </td>
<td>(</td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>inter_byte_timeout_</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>read_timeout_constant_</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>read_timeout_multiplier_</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>write_timeout_constant_</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">long&#160;</td>
<td class="paramname"><em>write_timeout_multiplier_</em> = <code>0</code>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<div class="fragment"><pre class="fragment"> : <a class="code" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">inter_byte_timeout</a>(inter_byte_timeout_),
<a class="code" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">read_timeout_constant</a>(read_timeout_constant_),
<a class="code" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">read_timeout_multiplier</a>(read_timeout_multiplier_),
<a class="code" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">write_timeout_constant</a>(write_timeout_constant_),
<a class="code" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">write_timeout_multiplier</a>(write_timeout_multiplier_)
{}
</pre></div>
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="abb885cffadb5ee57c6689d5a3c50dfad"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structserial_1_1timeout__t.html#abb885cffadb5ee57c6689d5a3c50dfad">serial::timeout_t::inter_byte_timeout</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of milliseconds between bytes received to timeout on. </p>
</div>
</div>
<a class="anchor" id="a2fc1dbde1ba635636379085f4e5f58fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structserial_1_1timeout__t.html#a2fc1dbde1ba635636379085f4e5f58fe">serial::timeout_t::read_timeout_constant</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constant number of milliseconds to wait after calling read. </p>
</div>
</div>
<a class="anchor" id="a548b76a924a2f8d5c902130cb587e6bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structserial_1_1timeout__t.html#a548b76a924a2f8d5c902130cb587e6bb">serial::timeout_t::read_timeout_multiplier</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A multiplier against the number of requested bytes to wait after calling read. </p>
</div>
</div>
<a class="anchor" id="acd6e36245118512785400915828cfd32"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structserial_1_1timeout__t.html#acd6e36245118512785400915828cfd32">serial::timeout_t::write_timeout_constant</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A constant number of milliseconds to wait after calling write. </p>
</div>
</div>
<a class="anchor" id="af43380c4255a9b8669970532048c4dfc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">long <a class="el" href="structserial_1_1timeout__t.html#af43380c4255a9b8669970532048c4dfc">serial::timeout_t::write_timeout_multiplier</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A multiplier against the number of requested bytes to wait after calling write. </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/serial/<a class="el" href="serial_8h_source.html">serial.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed May 2 2012 00:34:19 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