2012-05-02 21:50:05 -05:00
<!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 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
  < span id = "projectnumber" > 1.0< / span >
< / div >
2012-06-09 19:35:49 -05:00
< div id = "projectbrief" > Cross-platform serial port library written in C++< / div >
2012-05-02 21:50:05 -05:00
< / 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  Page< / span > < / a > < / li >
< li > < a href = "namespaces.html" > < span > Namespaces< / span > < / a > < / li >
< li class = "current" > < a href = "annotated.html" > < span > Data  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  Structures< / span > < / a > < / li >
< li > < a href = "classes.html" > < span > Data  Structure  Index< / span > < / a > < / li >
< li > < a href = "functions.html" > < span > Data  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" >   < / span > All< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(1)" > < span class = "SelectionMark" >   < / span > Data Structures< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(2)" > < span class = "SelectionMark" >   < / span > Namespaces< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(3)" > < span class = "SelectionMark" >   < / span > Files< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(4)" > < span class = "SelectionMark" >   < / span > Functions< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(5)" > < span class = "SelectionMark" >   < / span > Variables< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(6)" > < span class = "SelectionMark" >   < / span > Enumerations< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(7)" > < span class = "SelectionMark" >   < / span > Enumerator< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(8)" > < span class = "SelectionMark" >   < / 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_1_timeout.html" > Timeout< / a > < / li >
< / ul >
< / div >
< / div >
< div class = "header" >
< div class = "summary" >
< a href = "#pub-methods" > Public Member Functions< / a > |
2012-06-09 19:35:49 -05:00
< a href = "#pub-static-methods" > Static Public Member Functions< / a > |
2012-05-02 21:50:05 -05:00
< a href = "#pub-attribs" > Data Fields< / a > < / div >
< div class = "headertitle" >
< div class = "title" > serial::Timeout Struct Reference< / div > < / div >
< / div > <!-- header -->
< div class = "contents" >
< p > < code > #include < < a class = "el" href = "serial_8h_source.html" > serial.h< / a > > < / code > < / p >
< table class = "memberdecls" >
< tr > < td colspan = "2" > < h2 > < a name = "pub-methods" > < / a >
Public Member Functions< / h2 > < / td > < / tr >
2012-06-09 19:35:49 -05:00
< tr class = "memitem:a1a454b17f5d653b8e1b04b3ec2fead59" > < td class = "memItemLeft" align = "right" valign = "top" >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#a1a454b17f5d653b8e1b04b3ec2fead59" > Timeout< / a > (uint32_t inter_byte_timeout_=0, uint32_t read_timeout_constant_=0, uint32_t read_timeout_multiplier_=0, uint32_t write_timeout_constant_=0, uint32_t write_timeout_multiplier_=0)< / td > < / tr >
< tr > < td colspan = "2" > < h2 > < a name = "pub-static-methods" > < / a >
Static Public Member Functions< / h2 > < / td > < / tr >
< tr class = "memitem:adc68e33d2f94bfa33ba1062c363b9151" > < td class = "memItemLeft" align = "right" valign = "top" > static uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#adc68e33d2f94bfa33ba1062c363b9151" > max< / a > ()< / td > < / tr >
< tr class = "memitem:aa4fbd72e16f47c9aea9fb3c32ca17828" > < td class = "memItemLeft" align = "right" valign = "top" > static < a class = "el" href = "structserial_1_1_timeout.html" > Timeout< / a >   < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#aa4fbd72e16f47c9aea9fb3c32ca17828" > simpleTimeout< / a > (uint32_t timeout)< / td > < / tr >
2012-05-02 21:50:05 -05:00
< tr > < td colspan = "2" > < h2 > < a name = "pub-attribs" > < / a >
Data Fields< / h2 > < / td > < / tr >
2012-06-09 19:35:49 -05:00
< tr class = "memitem:ada15f2a0ae478cbb62ef79d1633b2b81" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#ada15f2a0ae478cbb62ef79d1633b2b81" > inter_byte_timeout< / a > < / td > < / tr >
< tr class = "memitem:a099244649dec66b6e0548480edeb2b9f" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#a099244649dec66b6e0548480edeb2b9f" > read_timeout_constant< / a > < / td > < / tr >
< tr class = "memitem:a64412753eb2edf1621716dd9f1a4e71e" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#a64412753eb2edf1621716dd9f1a4e71e" > read_timeout_multiplier< / a > < / td > < / tr >
< tr class = "memitem:accf01b97f83564f4ce3d6e5f63e21006" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#accf01b97f83564f4ce3d6e5f63e21006" > write_timeout_constant< / a > < / td > < / tr >
< tr class = "memitem:a31ddae32907cff9c3d27fa763981317d" > < td class = "memItemLeft" align = "right" valign = "top" > uint32_t  < / td > < td class = "memItemRight" valign = "bottom" > < a class = "el" href = "structserial_1_1_timeout.html#a31ddae32907cff9c3d27fa763981317d" > write_timeout_multiplier< / a > < / td > < / tr >
2012-05-02 21:50:05 -05:00
< / table >
< hr / > < a name = "details" id = "details" > < / a > < h2 > Detailed Description< / h2 >
2012-06-09 19:35:49 -05:00
< div class = "textblock" > < p > Structure for setting the timeout of the serial port, times are in milliseconds.< / p >
< p > In order to disable the interbyte timeout, set it to < a class = "el" href = "structserial_1_1_timeout.html#adc68e33d2f94bfa33ba1062c363b9151" > Timeout::max()< / a > . < / p >
2012-05-02 21:50:05 -05:00
< / div > < hr / > < h2 > Constructor & Destructor Documentation< / h2 >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "a1a454b17f5d653b8e1b04b3ec2fead59" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > < a class = "el" href = "structserial_1_1_timeout.html#a1a454b17f5d653b8e1b04b3ec2fead59" > serial::Timeout::Timeout< / a > < / td >
2012-05-02 21:50:05 -05:00
< td > (< / td >
2012-06-09 19:35:49 -05:00
< td class = "paramtype" > uint32_t  < / td >
2012-05-02 21:50:05 -05:00
< td class = "paramname" > < em > inter_byte_timeout_< / em > = < code > 0< / code > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2012-06-09 19:35:49 -05:00
< td class = "paramtype" > uint32_t  < / td >
2012-05-02 21:50:05 -05:00
< td class = "paramname" > < em > read_timeout_constant_< / em > = < code > 0< / code > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2012-06-09 19:35:49 -05:00
< td class = "paramtype" > uint32_t  < / td >
2012-05-02 21:50:05 -05:00
< td class = "paramname" > < em > read_timeout_multiplier_< / em > = < code > 0< / code > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2012-06-09 19:35:49 -05:00
< td class = "paramtype" > uint32_t  < / td >
2012-05-02 21:50:05 -05:00
< td class = "paramname" > < em > write_timeout_constant_< / em > = < code > 0< / code > , < / td >
< / tr >
< tr >
< td class = "paramkey" > < / td >
< td > < / td >
2012-06-09 19:35:49 -05:00
< td class = "paramtype" > uint32_t  < / td >
2012-05-02 21:50:05 -05:00
< td class = "paramname" > < em > write_timeout_multiplier_< / em > = < code > 0< / code >   < / td >
< / tr >
< tr >
< td > < / td >
< td > )< / td >
< td > < / td > < td > < code > [inline]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
2012-06-09 19:35:49 -05:00
< div class = "fragment" > < pre class = "fragment" > : < a class = "code" href = "structserial_1_1_timeout.html#ada15f2a0ae478cbb62ef79d1633b2b81" > inter_byte_timeout< / a > (inter_byte_timeout_),
< a class = "code" href = "structserial_1_1_timeout.html#a099244649dec66b6e0548480edeb2b9f" > read_timeout_constant< / a > (read_timeout_constant_),
< a class = "code" href = "structserial_1_1_timeout.html#a64412753eb2edf1621716dd9f1a4e71e" > read_timeout_multiplier< / a > (read_timeout_multiplier_),
< a class = "code" href = "structserial_1_1_timeout.html#accf01b97f83564f4ce3d6e5f63e21006" > write_timeout_constant< / a > (write_timeout_constant_),
< a class = "code" href = "structserial_1_1_timeout.html#a31ddae32907cff9c3d27fa763981317d" > write_timeout_multiplier< / a > (write_timeout_multiplier_)
{}
< / pre > < / div >
< / div >
< / div >
< hr / > < h2 > Member Function Documentation< / h2 >
< a class = "anchor" id = "adc68e33d2f94bfa33ba1062c363b9151" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > static uint32_t < a class = "el" href = "structserial_1_1_timeout.html#adc68e33d2f94bfa33ba1062c363b9151" > serial::Timeout::max< / a > < / td >
< td > (< / td >
< td class = "paramname" > < / td > < td > )< / td >
< td > < code > [inline, static]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< div class = "fragment" > < pre class = "fragment" > {< span class = "keywordflow" > return< / span > < a class = "code" href = "structserial_1_1_timeout.html#adc68e33d2f94bfa33ba1062c363b9151" > std::numeric_limits< uint32_t> ::max< / a > ();}
< / pre > < / div >
< / div >
< / div >
< a class = "anchor" id = "aa4fbd72e16f47c9aea9fb3c32ca17828" > < / a >
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
< td class = "memname" > static < a class = "el" href = "structserial_1_1_timeout.html" > Timeout< / a > < a class = "el" href = "structserial_1_1_timeout.html#aa4fbd72e16f47c9aea9fb3c32ca17828" > serial::Timeout::simpleTimeout< / a > < / td >
< td > (< / td >
< td class = "paramtype" > uint32_t  < / td >
< td class = "paramname" > < em > timeout< / em > < / td > < td > )< / td >
< td > < code > [inline, static]< / code > < / td >
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Convenience function to generate < a class = "el" href = "structserial_1_1_timeout.html" > Timeout< / a > structs using a single absolute timeout.< / p >
< dl class = "params" > < dt > < b > Parameters:< / b > < / dt > < dd >
< table class = "params" >
< tr > < td class = "paramname" > timeout< / td > < td > A long that defines the time in milliseconds until a timeout occurs after a call to read or write is made.< / td > < / tr >
< / table >
< / dd >
< / dl >
< dl class = "section return" > < dt > Returns:< / dt > < dd > < a class = "el" href = "structserial_1_1_timeout.html" > Timeout< / a > struct that represents this simple timeout provided. < / dd > < / dl >
< div class = "fragment" > < pre class = "fragment" > {
< span class = "keywordflow" > return< / span > < a class = "code" href = "structserial_1_1_timeout.html#a1a454b17f5d653b8e1b04b3ec2fead59" > Timeout< / a > (< a class = "code" href = "structserial_1_1_timeout.html#adc68e33d2f94bfa33ba1062c363b9151" > max< / a > (), timeout, 0, timeout, 0);
}
2012-05-02 21:50:05 -05:00
< / pre > < / div >
< / div >
< / div >
< hr / > < h2 > Field Documentation< / h2 >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "ada15f2a0ae478cbb62ef79d1633b2b81" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > uint32_t < a class = "el" href = "structserial_1_1_timeout.html#ada15f2a0ae478cbb62ef79d1633b2b81" > serial::Timeout::inter_byte_timeout< / a > < / td >
2012-05-02 21:50:05 -05:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > Number of milliseconds between bytes received to timeout on. < / p >
< / div >
< / div >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "a099244649dec66b6e0548480edeb2b9f" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > uint32_t < a class = "el" href = "structserial_1_1_timeout.html#a099244649dec66b6e0548480edeb2b9f" > serial::Timeout::read_timeout_constant< / a > < / td >
2012-05-02 21:50:05 -05:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > A constant number of milliseconds to wait after calling read. < / p >
< / div >
< / div >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "a64412753eb2edf1621716dd9f1a4e71e" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > uint32_t < a class = "el" href = "structserial_1_1_timeout.html#a64412753eb2edf1621716dd9f1a4e71e" > serial::Timeout::read_timeout_multiplier< / a > < / td >
2012-05-02 21:50:05 -05:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > A multiplier against the number of requested bytes to wait after calling read. < / p >
< / div >
< / div >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "accf01b97f83564f4ce3d6e5f63e21006" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > uint32_t < a class = "el" href = "structserial_1_1_timeout.html#accf01b97f83564f4ce3d6e5f63e21006" > serial::Timeout::write_timeout_constant< / a > < / td >
2012-05-02 21:50:05 -05:00
< / tr >
< / table >
< / div >
< div class = "memdoc" >
< p > A constant number of milliseconds to wait after calling write. < / p >
< / div >
< / div >
2012-06-09 19:35:49 -05:00
< a class = "anchor" id = "a31ddae32907cff9c3d27fa763981317d" > < / a >
2012-05-02 21:50:05 -05:00
< div class = "memitem" >
< div class = "memproto" >
< table class = "memname" >
< tr >
2012-06-09 19:35:49 -05:00
< td class = "memname" > uint32_t < a class = "el" href = "structserial_1_1_timeout.html#a31ddae32907cff9c3d27fa763981317d" > serial::Timeout::write_timeout_multiplier< / a > < / td >
2012-05-02 21:50:05 -05:00
< / 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 >
2012-06-09 20:05:44 -05:00
Generated on Sat Jun 9 2012 20:04:37 for serial by   < a href = "http://www.doxygen.org/index.html" >
2012-05-02 21:50:05 -05:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / >
< / a > 1.8.0
< / small > < / address >
< / body >
< / html >
