<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::SerialPort Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_serial_port.html">SerialPort</a></div>
<h1>ost::SerialPort Class Reference</h1><!-- doxytag: class="ost::SerialPort" --><!-- doxytag: inherits="ost::Serial,ost::TimerPort" -->The serial port is an internal class which is attached to and then serviced by a specified <a class="el" href="classost_1_1_serial_service.html">SerialService</a> thread.base class for thread pool serviced serial I/O.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="serial_8h-source.html">serial.h</a>></code>
<p>
<p>Inheritance diagram for ost::SerialPort:
<p><center><img src="classost_1_1_serial_port.png" usemap="#ost::SerialPort_map" border="0" alt=""></center>
<map name="ost::SerialPort_map">
<area href="classost_1_1_serial.html" alt="ost::Serial" shape="rect" coords="0,0,90,24">
<area href="classost_1_1_timer_port.html" alt="ost::TimerPort" shape="rect" coords="100,0,190,24">
</map>
<a href="classost_1_1_serial_port-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#eb008981e1a1d2eff230b231c3ce5d9c">setTimer</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout=0)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived setTimer to notify the service thread pool of changes in expected timeout. <a href="#eb008981e1a1d2eff230b231c3ce5d9c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#4fa45b7494efbcd0c1b28a724f93b6b3">incTimer</a> (<a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> timeout)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived incTimer to notify the service thread pool of a change in expected timeout. <a href="#4fa45b7494efbcd0c1b28a724f93b6b3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#8e281b17e996c4f5eb18bdbb9a0b3e4b">SerialPort</a> (<a class="el" href="classost_1_1_serial_service.html">SerialService</a> *svc, const char *name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a tty serial port for a named serial device. <a href="#8e281b17e996c4f5eb18bdbb9a0b3e4b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#1c4a6f8cd51e17f153a0575c1036a8a5">~SerialPort</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Disconnect the <a class="el" href="classost_1_1_serial.html">Serial</a> Port from the service pool thread and shutdown the port. <a href="#1c4a6f8cd51e17f153a0575c1036a8a5"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#b12b5f15481bf49b32e76a740c61ae6c">setDetectPending</a> (bool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to indicate if the service thread should monitor pending data for us. <a href="#b12b5f15481bf49b32e76a740c61ae6c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#85cd2f84d0117820545694ff4e122912">getDetectPending</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current state of the DetectPending flag. <a href="#85cd2f84d0117820545694ff4e122912"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#247a1b23aa9b819dadd3f671f5cbbdb9">setDetectOutput</a> (bool)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Used to indicate if output ready monitoring should be performed by the service thread. <a href="#247a1b23aa9b819dadd3f671f5cbbdb9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#eeb3b9dbdaaa73b0c2960d332f80207c">getDetectOutput</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current state of the DetectOutput flag. <a href="#eeb3b9dbdaaa73b0c2960d332f80207c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#5a0f7222d19dc7f97ebbd7fd471f39ac">expired</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread when the objects timer has expired. <a href="#5a0f7222d19dc7f97ebbd7fd471f39ac"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#47facdf73be726e440d39872130bf5b2">pending</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread when input data is pending for this tty port. <a href="#47facdf73be726e440d39872130bf5b2"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#c56f59989b9b11b094064e70eef6a681">disconnect</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Called by the service thread when an exception has occured such as a hangup. <a href="#c56f59989b9b11b094064e70eef6a681"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#2ace6514780e229ea0ac7dff9778583e">output</a> (void *buf, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Transmit "send" data to the serial port. <a href="#2ace6514780e229ea0ac7dff9778583e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#fc68b51175f68493f644af5f3a5d8985">output</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform when output is available for sending data. <a href="#fc68b51175f68493f644af5f3a5d8985"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#eb0db8bb689d4610e91ce81f68dfd590">input</a> (void *buf, int len)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Receive "input" for pending data from the serial port. <a href="#eb0db8bb689d4610e91ce81f68dfd590"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html#a8c4721865365c59db66755ea23bc4fb">SerialService</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The serial port is an internal class which is attached to and then serviced by a specified <a class="el" href="classost_1_1_serial_service.html">SerialService</a> thread.base class for thread pool serviced serial I/O.
<p>
Derived versions of this class offer specific functionality such as serial integration protocols.<p>
The TTYPort and TTYService classes are used to form thread-pool serviced serial I/O protocol sets. These can be used when one has a large number of serial devices to manage, and a single (or limited number of) thread(s) can then be used to service the tty port objects present. Each tty port supports a timer control and several virtual methods that the service thread can call when events occur. This model provides for "callback" event management, whereby the service thread performs a "callback" into the port object when events occur. Specific events supported include the expiration of a TTYPort timer, pending input data waiting to be read, and "sighup" connection breaks.<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="8e281b17e996c4f5eb18bdbb9a0b3e4b"></a><!-- doxytag: member="ost::SerialPort::SerialPort" ref="8e281b17e996c4f5eb18bdbb9a0b3e4b" args="(SerialService *svc, const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::SerialPort::SerialPort </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_serial_service.html">SerialService</a> * </td>
<td class="mdname" nowrap> <em>svc</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>const char * </td>
<td class="mdname" nowrap> <em>name</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Construct a tty serial port for a named serial device.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>svc</em> </td><td>pool thread object. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>of tty port. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="1c4a6f8cd51e17f153a0575c1036a8a5"></a><!-- doxytag: member="ost::SerialPort::~SerialPort" ref="1c4a6f8cd51e17f153a0575c1036a8a5" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::SerialPort::~SerialPort </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Disconnect the <a class="el" href="classost_1_1_serial.html">Serial</a> Port from the service pool thread and shutdown the port.
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c56f59989b9b11b094064e70eef6a681"></a><!-- doxytag: member="ost::SerialPort::disconnect" ref="c56f59989b9b11b094064e70eef6a681" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SerialPort::disconnect </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread when an exception has occured such as a hangup.
<p>
</td>
</tr>
</table>
<a class="anchor" name="5a0f7222d19dc7f97ebbd7fd471f39ac"></a><!-- doxytag: member="ost::SerialPort::expired" ref="5a0f7222d19dc7f97ebbd7fd471f39ac" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SerialPort::expired </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread when the objects timer has expired.
<p>
</td>
</tr>
</table>
<a class="anchor" name="eeb3b9dbdaaa73b0c2960d332f80207c"></a><!-- doxytag: member="ost::SerialPort::getDetectOutput" ref="eeb3b9dbdaaa73b0c2960d332f80207c" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::SerialPort::getDetectOutput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the current state of the DetectOutput flag.
<p>
</td>
</tr>
</table>
<a class="anchor" name="85cd2f84d0117820545694ff4e122912"></a><!-- doxytag: member="ost::SerialPort::getDetectPending" ref="85cd2f84d0117820545694ff4e122912" args="(void) const " --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::SerialPort::getDetectPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap> const<code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Get the current state of the DetectPending flag.
<p>
</td>
</tr>
</table>
<a class="anchor" name="4fa45b7494efbcd0c1b28a724f93b6b3"></a><!-- doxytag: member="ost::SerialPort::incTimer" ref="4fa45b7494efbcd0c1b28a724f93b6b3" args="(timeout_t timeout)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SerialPort::incTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Derived incTimer to notify the service thread pool of a change in expected timeout.
<p>
This allows <a class="el" href="classost_1_1_serial_service.html">SerialService</a> to reschedule all timers.
<p>
Reimplemented from <a class="el" href="classost_1_1_timer_port.html#b2c732120c3bb09e8d38a87b7443906d">ost::TimerPort</a>. </td>
</tr>
</table>
<a class="anchor" name="eb0db8bb689d4610e91ce81f68dfd590"></a><!-- doxytag: member="ost::SerialPort::input" ref="eb0db8bb689d4610e91ce81f68dfd590" args="(void *buf, int len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::SerialPort::input </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Receive "input" for pending data from the serial port.
<p>
This is not a public member since it's meant to support internal protocols rather than direct external access to the device.<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes received. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>address of buffer to input. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of input buffer used. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="fc68b51175f68493f644af5f3a5d8985"></a><!-- doxytag: member="ost::SerialPort::output" ref="fc68b51175f68493f644af5f3a5d8985" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SerialPort::output </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Perform when output is available for sending data.
<p>
</td>
</tr>
</table>
<a class="anchor" name="2ace6514780e229ea0ac7dff9778583e"></a><!-- doxytag: member="ost::SerialPort::output" ref="2ace6514780e229ea0ac7dff9778583e" args="(void *buf, int len)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int ost::SerialPort::output </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void * </td>
<td class="mdname" nowrap> <em>buf</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>len</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Transmit "send" data to the serial port.
<p>
This is not public since it's meant to support internal protocols rather than direct public access to the device.<p>
<dl compact><dt><b>Returns:</b></dt><dd>number of bytes send. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>buf</em> </td><td>address of buffer to send. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>len</em> </td><td>of bytes to send. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="47facdf73be726e440d39872130bf5b2"></a><!-- doxytag: member="ost::SerialPort::pending" ref="47facdf73be726e440d39872130bf5b2" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::SerialPort::pending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Called by the service thread when input data is pending for this tty port.
<p>
Effected by setPacketInput and by setLineInput. </td>
</tr>
</table>
<a class="anchor" name="247a1b23aa9b819dadd3f671f5cbbdb9"></a><!-- doxytag: member="ost::SerialPort::setDetectOutput" ref="247a1b23aa9b819dadd3f671f5cbbdb9" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SerialPort::setDetectOutput </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to indicate if output ready monitoring should be performed by the service thread.
<p>
</td>
</tr>
</table>
<a class="anchor" name="b12b5f15481bf49b32e76a740c61ae6c"></a><!-- doxytag: member="ost::SerialPort::setDetectPending" ref="b12b5f15481bf49b32e76a740c61ae6c" args="(bool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SerialPort::setDetectPending </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">bool </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Used to indicate if the service thread should monitor pending data for us.
<p>
</td>
</tr>
</table>
<a class="anchor" name="eb008981e1a1d2eff230b231c3ce5d9c"></a><!-- doxytag: member="ost::SerialPort::setTimer" ref="eb008981e1a1d2eff230b231c3ce5d9c" args="(timeout_t timeout=0)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::SerialPort::setTimer </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="thread_8h.html#f412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="mdname1" valign="top" nowrap> <em>timeout</em> = <code>0</code> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Derived setTimer to notify the service thread pool of changes in expected timeout.
<p>
This allows <a class="el" href="classost_1_1_serial_service.html">SerialService</a> to reschedule all timers.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>timeout</em> </td><td>in milliseconds. </td></tr>
</table>
</dl>
<p>
Reimplemented from <a class="el" href="classost_1_1_timer_port.html#32b59a072fe60d94251a53579b3ca17f">ost::TimerPort</a>. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="a8c4721865365c59db66755ea23bc4fb"></a><!-- doxytag: member="ost::SerialPort::SerialService" ref="a8c4721865365c59db66755ea23bc4fb" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">friend class <a class="el" href="classost_1_1_serial_service.html">SerialService</a><code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="serial_8h-source.html">serial.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
