<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ost::Serial class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.10 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center>
<hr><h1>ost::Serial Class Reference</h1>The <a class="el" href="classost_1_1_serial.html">Serial</a> class is used as the base for all serial I/O services under APE. base class for all serial I/O services.
<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::Serial::
<p><center><img src="classost_1_1_serial.gif" usemap="#ost::Serial_map" border="0"></center>
<map name="ost::Serial_map">
<area href="classost_1_1_serial_port.html" alt="ost::SerialPort" shape="rect" coords="0,56,101,80">
<area href="classost_1_1_t_t_y_stream.html" alt="ost::TTYStream" shape="rect" coords="111,56,212,80">
<area href="classost_1_1_t_t_y_session.html" alt="ost::TTYSession" shape="rect" coords="55,112,156,136">
<area href="classost_1_1ttystream.html" alt="ost::ttystream" shape="rect" coords="166,112,267,136">
</map>
<a href="classost_1_1_serial-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a0">~Serial</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to destory the object.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>Serial & </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a1">operator=</a> (const Serial &from)</td></tr>
<tr><td> </td><td><font size=-1><em><a class="el" href="classost_1_1_serial.html">Serial</a> ports may also be duplecated by the assignment operator.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a2">setSpeed</a> (unsigned long speed)</td></tr>
<tr><td> </td><td><font size=-1><em>Set serial port speed for both input and output.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a3">setCharBits</a> (int bits)</td></tr>
<tr><td> </td><td><font size=-1><em>Set character size.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a4">setParity</a> (<a class="el" href="namespaceost.html#a43">sioparity_t</a> parity)</td></tr>
<tr><td> </td><td><font size=-1><em>Set parity mode.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a5">setStopBits</a> (int bits)</td></tr>
<tr><td> </td><td><font size=-1><em>Set number of stop bits.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a6">setFlowControl</a> (<a class="el" href="namespaceost.html#a42">sioflow_t</a> flow)</td></tr>
<tr><td> </td><td><font size=-1><em>Set flow control.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a7">toggleDTR</a> (<a class="el" href="thread_8h.html#a11">timeout_t</a> millisec)</td></tr>
<tr><td> </td><td><font size=-1><em>Set the DTR mode off momentarily.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a8">sendBreak</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Send the "break" signal.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a9">getErrorNumber</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Often used by a "catch" to fetch the last error of a thrown serial.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>char * </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a10">getErrorString</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Often used by a "catch" to fetch the user set error string of a thrown serial.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a11">getBufferSize</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Get the "buffer" size for buffered operations.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#a12">isPending</a> (<a class="el" href="namespaceost.html#a44">siopend_t</a> pend, <a class="el" href="thread_8h.html#a11">timeout_t</a> timeout=TIMEOUT_INF)</td></tr>
<tr><td> </td><td><font size=-1><em>Get the status of pending operations.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Methods</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceost.html#a41">sioerror_t</a> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b0">Error</a> (<a class="el" href="namespaceost.html#a41">sioerror_t</a> error, char *errstr=NULL)</td></tr>
<tr><td> </td><td><font size=-1><em>This service is used to throw all serial errors which usually occur during the serial constructor.</em> <a href="#b0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b1">Error</a> (char *errstr)</td></tr>
<tr><td> </td><td><font size=-1><em>This service is used to thow application defined serial errors where the application specific error code is a string.</em> <a href="#b1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b2">setError</a> (bool enable)</td></tr>
<tr><td> </td><td><font size=-1><em>This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag.</em> <a href="#b2">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b3">setPacketInput</a> (int size, unsigned char btimer=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Set packet read mode and "size" of packet read buffer.</em> <a href="#b3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b4">setLineInput</a> (char newline=13, char nl1=0)</td></tr>
<tr><td> </td><td><font size=-1><em>Set "line buffering" read mode and specifies the newline character to be used in seperating line records.</em> <a href="#b4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b5">Restore</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Restore serial device to the original settings at time of open.</em> <a href="#b5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b6">flushInput</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to flush the input waiting queue.</em> <a href="#b6">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b7">flushOutput</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to flush any pending output data.</em> <a href="#b7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b8">waitOutput</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to wait until all output has been sent.</em> <a href="#b8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b9">endSerial</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used as the default destructor for ending serial I/O services.</em> <a href="#b9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b10">initConfig</a> (void)</td></tr>
<tr><td> </td><td><font size=-1><em>Used to initialize a newly opened serial file handle.</em> <a href="#b10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b11">Serial</a> (const char *name)</td></tr>
<tr><td> </td><td><font size=-1><em>A serial object may be constructed from a named file on the file system.</em> <a href="#b11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#b12">Serial</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>This allows later <a class="el" href="classost_1_1ttystream.html">ttystream</a> class to open and close a serial device.</em> <a href="#b12">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#n0">dev</a></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classost_1_1_serial.html#n1">bufsize</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="classost_1_1_serial.html">Serial</a> class is used as the base for all serial I/O services under APE. base class for all serial I/O services.
<p>
A serial is a system serial port that is used either for line or packet based data input. <a class="el" href="classost_1_1_serial.html">Serial</a> ports may also be "streamable" in a derived form.
<p>
Common C++ serial I/O classes are used to manage serial devices and implement serial device protocols. From the point of view of Common C++, serial devices are supported by the underlying Posix specified "termios" call interface.
<p>
The serial I/O base class is used to hold a descriptor to a serial device and to provide an exception handling interface for all serial I/O classes. The base class is also used to specify serial I/O properties such as communication speed, flow control, data size, and parity. The "<a class="el" href="classost_1_1_serial.html">Serial</a>" base class is not itself directly used in application development, however.
<p>
Common C++ <a class="el" href="classost_1_1_serial.html">Serial</a> I/O is itself divided into two conceptual modes; frame oriented and line oriented I/O. Both frame and line oriented I/O makes use of the ability of the underlying tty driver to buffer data and return "ready" status from when select either a specified number of bytes or newline record has been reached by manipulating termios c_cc fields appropriately. This provides some advantage in that a given thread servicing a serial port can block and wait rather than have to continually poll or read each and every byte as soon as it appears at the serial port.
<p>
<dl compact><dt><b>
Author: </b><dd>
David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="b11" doxytag="ost::Serial::Serial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ost::Serial::Serial </td>
<td class="md">( </td>
<td class="md">const char *</td>
<td class="mdname1"> <em>name</em> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
A serial object may be constructed from a named file on the file system.
<p>
This named device must be "isatty()".<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>name
</em> </td><td>
of file. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b12" doxytag="ost::Serial::Serial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> ost::Serial::Serial </td>
<td class="md">( </td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This allows later <a class="el" href="classost_1_1ttystream.html">ttystream</a> class to open and close a serial device.
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="ost::Serial::~Serial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual ost::Serial::~Serial </td>
<td class="md">( </td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to destory the object.
<p>
By assuring the socket base class is a virtual destructor, we can assure the full object is properly terminated. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="b1" doxytag="ost::Serial::Error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::Error </td>
<td class="md">( </td>
<td class="md">char *</td>
<td class="mdname1"> <em>errstr</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This service is used to thow application defined serial errors where the application specific error code is a string.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>errstr
</em> </td><td>
string or message to pass. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b0" doxytag="ost::Serial::Error"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::Error </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a41">sioerror_t</a></td>
<td class="mdname"> <em>error</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">char *</td>
<td class="mdname"> <em>errstr</em> = NULL</td>
</tr>
<tr>
<td></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>
This service is used to throw all serial errors which usually occur during the serial constructor.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>error
</em> </td><td>
defined serial error id. </td></tr>
<tr><td valign=top><em>errstr
</em> </td><td>
string or message to optionally pass. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b5" doxytag="ost::Serial::Restore"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::Restore </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Restore serial device to the original settings at time of open.
<p>
</td>
</tr>
</table>
<a name="b9" doxytag="ost::Serial::endSerial"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::endSerial </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Used as the default destructor for ending serial I/O services.
<p>
It will restore the port to it's original state. </td>
</tr>
</table>
<a name="b6" doxytag="ost::Serial::flushInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::flushInput </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Used to flush the input waiting queue.
<p>
</td>
</tr>
</table>
<a name="b7" doxytag="ost::Serial::flushOutput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::flushOutput </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Used to flush any pending output data.
<p>
</td>
</tr>
</table>
<a name="a11" doxytag="ost::Serial::getBufferSize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::Serial::getBufferSize </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the "buffer" size for buffered operations.
<p>
This can be used when setting packet or line read modes to determine how many bytes to wait for in a given read call.
<p>
<dl compact><dt><b>
Returns: </b><dd>
number of bytes used for buffering. </dl> </td>
</tr>
</table>
<a name="a9" doxytag="ost::Serial::getErrorNumber"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::getErrorNumber </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Often used by a "catch" to fetch the last error of a thrown serial.
<p>
<dl compact><dt><b>
Returns: </b><dd>
error numbr of last sioerror_t. </dl> </td>
</tr>
</table>
<a name="a10" doxytag="ost::Serial::getErrorString"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> char* ost::Serial::getErrorString </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [inline]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Often used by a "catch" to fetch the user set error string of a thrown serial.
<p>
<dl compact><dt><b>
Returns: </b><dd>
string for error message. </dl> </td>
</tr>
</table>
<a name="b10" doxytag="ost::Serial::initConfig"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::initConfig </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Used to initialize a newly opened serial file handle.
<p>
You should set serial properties and DTR manually before first use. </td>
</tr>
</table>
<a name="a12" doxytag="ost::Serial::isPending"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool ost::Serial::isPending </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a44">siopend_t</a></td>
<td class="mdname"> <em>pend</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md"><a class="el" href="thread_8h.html#a11">timeout_t</a></td>
<td class="mdname"> <em>timeout</em> = TIMEOUT_INF</td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Get the status of pending operations.
<p>
This can be used to examine if input or output is waiting, or if an error has occured on the serial device.
<p>
<dl compact><dt><b>
Returns: </b><dd>
true if ready, false if timeout. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>ready
</em> </td><td>
check to perform. </td></tr>
<tr><td valign=top><em>timeout
</em> </td><td>
in milliseconds. </td></tr>
</table>
</dl>
<p>
Reimplemented in <a class="el" href="classost_1_1_t_t_y_stream.html#a5">ost::TTYStream</a>. </td>
</tr>
</table>
<a name="a1" doxytag="ost::Serial::operator="></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> Serial& ost::Serial::operator= </td>
<td class="md">( </td>
<td class="md">const Serial &</td>
<td class="mdname1"> <em>from</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<a class="el" href="classost_1_1_serial.html">Serial</a> ports may also be duplecated by the assignment operator.
<p>
</td>
</tr>
</table>
<a name="a8" doxytag="ost::Serial::sendBreak"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::sendBreak </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Send the "break" signal.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="ost::Serial::setCharBits"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::setCharBits </td>
<td class="md">( </td>
<td class="md">int</td>
<td class="mdname1"> <em>bits</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set character size.
<p>
<dl compact><dt><b>
Returns: </b><dd>
0 on success. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>character
</em> </td><td>
size to use (usually 7 or 8). </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b2" doxytag="ost::Serial::setError"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::setError </td>
<td class="md">( </td>
<td class="md">bool</td>
<td class="mdname1"> <em>enable</em> </td>
<td class="md">) </td>
<td class="md"><code> [inline, protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>true
</em> </td><td>
to enable handler. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a6" doxytag="ost::Serial::setFlowControl"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::setFlowControl </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a42">sioflow_t</a></td>
<td class="mdname1"> <em>flow</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set flow control.
<p>
<dl compact><dt><b>
Returns: </b><dd>
0 on success. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>flow
</em> </td><td>
control mode. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b4" doxytag="ost::Serial::setLineInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::Serial::setLineInput </td>
<td class="md">( </td>
<td class="md">char</td>
<td class="mdname"> <em>newline</em> = 13, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">char</td>
<td class="mdname"> <em>nl1</em> = 0</td>
</tr>
<tr>
<td></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>
Set "line buffering" read mode and specifies the newline character to be used in seperating line records.
<p>
isPending can then be used to wait for an entire line of input.
<p>
<dl compact><dt><b>
Returns: </b><dd>
size of conical input buffer. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>newline
</em> </td><td>
character. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b3" doxytag="ost::Serial::setPacketInput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::Serial::setPacketInput </td>
<td class="md">( </td>
<td class="md">int</td>
<td class="mdname"> <em>size</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md">unsigned char</td>
<td class="mdname"> <em>btimer</em> = 0</td>
</tr>
<tr>
<td></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>
Set packet read mode and "size" of packet read buffer.
<p>
This sets VMIN to x. VTIM is normally set to "0" so that "<a class="el" href="classost_1_1_serial.html#a12">isPending</a>()" can wait for an entire packet rather than just the first byte.
<p>
<dl compact><dt><b>
Returns: </b><dd>
actual buffer size set. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>size
</em> </td><td>
of packet read request. </td></tr>
<tr><td valign=top><em>optional
</em> </td><td>
inter-byte data packet timeout. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="ost::Serial::setParity"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::setParity </td>
<td class="md">( </td>
<td class="md"><a class="el" href="namespaceost.html#a43">sioparity_t</a></td>
<td class="mdname1"> <em>parity</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set parity mode.
<p>
<dl compact><dt><b>
Returns: </b><dd>
0 on success. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>parity
</em> </td><td>
mode. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a2" doxytag="ost::Serial::setSpeed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::setSpeed </td>
<td class="md">( </td>
<td class="md">unsigned long</td>
<td class="mdname1"> <em>speed</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set serial port speed for both input and output.
<p>
<dl compact><dt><b>
Returns: </b><dd>
0 on success. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>speed
</em> </td><td>
to select. 0 signifies modem "hang up". </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a5" doxytag="ost::Serial::setStopBits"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> <a class="el" href="namespaceost.html#a41">sioerror_t</a> ost::Serial::setStopBits </td>
<td class="md">( </td>
<td class="md">int</td>
<td class="mdname1"> <em>bits</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set number of stop bits.
<p>
<dl compact><dt><b>
Returns: </b><dd>
0 on success. </dl><dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>stop
</em> </td><td>
bits. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a7" doxytag="ost::Serial::toggleDTR"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::toggleDTR </td>
<td class="md">( </td>
<td class="md"><a class="el" href="thread_8h.html#a11">timeout_t</a></td>
<td class="mdname1"> <em>millisec</em> </td>
<td class="md">) </td>
<td class="md"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Set the DTR mode off momentarily.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>number
</em> </td><td>
of milliseconds. </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="b8" doxytag="ost::Serial::waitOutput"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void ost::Serial::waitOutput </td>
<td class="md">( </td>
<td class="md">void</td>
<td class="mdname1"> </td>
<td class="md">) </td>
<td class="md"><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Used to wait until all output has been sent.
<p>
</td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="n1" doxytag="ost::Serial::bufsize"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::Serial::bufsize<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a name="n0" doxytag="ost::Serial::dev"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int ost::Serial::dev<code> [protected]</code>
</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><address><small>Generated at Fri Jan 4 18:51:50 2002 for CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.gif" alt="doxygen" align="middle" border=0
width=110 height=53></a>1.2.10 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
© 1997-2001</small></address>
</body>
</html>
distrib
>
Mandriva
>
8.2
>
i586
>
media
>
contrib
>
by-pkgid
>
68d373e54fb21da3730c08bede406633
>
files
>
615
