<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html><head><meta name="robots" content="noindex"> <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> <title>serial.h File Reference</title> <link href="doxygen.css" rel="stylesheet" type="text/css"> </head><body bgcolor="#ffffff"> <!-- Generated by Doxygen 1.2.5 on Thu Oct 4 15:32:58 2001 --> <center> <a class="qindex" href="index.html">Main Page</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="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> </center> <hr><h1>serial.h File Reference</h1> <p> <a href="serial_h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0> <tr><td colspan=2><br><h2>Compounds</h2></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_serial.html">Serial</a></td></tr> <tr><td> </td><td><font size=-1><em>The Serial class is used as the base for all serial I/O services under APE. base class for all serial I/O services.</em> <a href="class_serial.html#_details">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_serialport.html">SerialPort</a></td></tr> <tr><td> </td><td><font size=-1><em>The serial port is an internal class which is attached to and then serviced by a specified <a class="el" href="class_serialservice.html">SerialService</a> thread. base class for thread pool serviced serial I/O.</em> <a href="class_serialport.html#_details">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_serialservice.html">SerialService</a></td></tr> <tr><td> </td><td><font size=-1><em>The SerialService is a thead service object that is meant to service attached serial ports. <a class="el" href="class_thread.html">Thread</a> pool service for serial ports.</em> <a href="class_serialservice.html#_details">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_ttysession.html">TTYSession</a></td></tr> <tr><td> </td><td><font size=-1><em>The TTYSession aggragates a <a class="el" href="class_ttystream.html">TTYStream</a> and a Common C++ <a class="el" href="class_thread.html">Thread</a> which is assumed to be the execution context that will be used to perform actual I/O operations. This class is very anagolous to <a class="el" href="class_tcpsession.html">TCPSession</a>.</em> <a href="class_ttysession.html#_details">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_ttystream.html">ttystream</a></td></tr> <tr><td> </td><td><font size=-1><em>A more natural C++ "ttystream" class for use by non-threaded applications. C++ "fstream" style ttystream class.</em> <a href="class_ttystream.html#_details">More...</a><em></em></font><br><br></td></tr> <tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="class_ttystream.html">TTYStream</a></td></tr> <tr><td colspan=2><br><h2>Enumerations</h2></td></tr> <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="serial_h.html#a24">sioerror_t</a> { <br> <a class="el" href="serial_h.html#a24a0">SERIAL_SUCCESS</a> = 0, <a class="el" href="serial_h.html#a24a1">SERIAL_OPEN_NOTTY</a>, <a class="el" href="serial_h.html#a24a2">SERIAL_OPEN_FAILED</a>, <a class="el" href="serial_h.html#a24a3">SERIAL_SPEED_INVALID</a>, <br> <a class="el" href="serial_h.html#a24a4">SERIAL_FLOW_INVALID</a>, <a class="el" href="serial_h.html#a24a5">SERIAL_PARITY_INVALID</a>, <a class="el" href="serial_h.html#a24a6">SERIAL_CHARSIZE_INVALID</a>, <a class="el" href="serial_h.html#a24a7">SERIAL_STOPBITS_INVALID</a>, <br> <a class="el" href="serial_h.html#a24a8">SERIAL_OPTION_INVALID</a>, <a class="el" href="serial_h.html#a24a9">SERIAL_RESOURCE_FAILURE</a>, <a class="el" href="serial_h.html#a24a10">SERIAL_OUTPUT_ERROR</a>, <a class="el" href="serial_h.html#a24a11">SERIAL_INPUT_ERROR</a>, <br> <a class="el" href="serial_h.html#a24a12">SERIAL_TIMEOUT_ERROR</a>, <a class="el" href="serial_h.html#a24a13">SERIAL_EXTENDED_ERROR</a> <br> }</td></tr> <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="serial_h.html#a25">sioflow_t</a> { <a class="el" href="serial_h.html#a25a14">SERIAL_FLOW_NONE</a>, <a class="el" href="serial_h.html#a25a15">SERIAL_FLOW_SOFT</a>, <a class="el" href="serial_h.html#a25a16">SERIAL_FLOW_HARD</a>, <a class="el" href="serial_h.html#a25a17">SERIAL_FLOW_BOTH</a> }</td></tr> <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="serial_h.html#a26">sioparity_t</a> { <a class="el" href="serial_h.html#a26a18">SERIAL_PARITY_NONE</a>, <a class="el" href="serial_h.html#a26a19">SERIAL_PARITY_ODD</a>, <a class="el" href="serial_h.html#a26a20">SERIAL_PARITY_EVEN</a> }</td></tr> <tr><td nowrap align=right valign=top>enum </td><td valign=bottom><a class="el" href="serial_h.html#a27">siopend_t</a> { <a class="el" href="serial_h.html#a27a21">SERIAL_PENDING_INPUT</a>, <a class="el" href="serial_h.html#a27a22">SERIAL_PENDING_OUTPUT</a>, <a class="el" href="serial_h.html#a27a23">SERIAL_PENDING_ERROR</a> }</td></tr> </table> <hr><h2>Enumeration Type Documentation</h2> <a name="a24" doxytag="serial.h::sioerror_t"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> enum sioerror_t </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt> <b>Enumeration values:</b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><a name="a24a0" doxytag="SERIAL_SUCCESS"></a><em>SERIAL_SUCCESS</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a1" doxytag="SERIAL_OPEN_NOTTY"></a><em>SERIAL_OPEN_NOTTY</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a2" doxytag="SERIAL_OPEN_FAILED"></a><em>SERIAL_OPEN_FAILED</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a3" doxytag="SERIAL_SPEED_INVALID"></a><em>SERIAL_SPEED_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a4" doxytag="SERIAL_FLOW_INVALID"></a><em>SERIAL_FLOW_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a5" doxytag="SERIAL_PARITY_INVALID"></a><em>SERIAL_PARITY_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a6" doxytag="SERIAL_CHARSIZE_INVALID"></a><em>SERIAL_CHARSIZE_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a7" doxytag="SERIAL_STOPBITS_INVALID"></a><em>SERIAL_STOPBITS_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a8" doxytag="SERIAL_OPTION_INVALID"></a><em>SERIAL_OPTION_INVALID</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a9" doxytag="SERIAL_RESOURCE_FAILURE"></a><em>SERIAL_RESOURCE_FAILURE</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a10" doxytag="SERIAL_OUTPUT_ERROR"></a><em>SERIAL_OUTPUT_ERROR</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a11" doxytag="SERIAL_INPUT_ERROR"></a><em>SERIAL_INPUT_ERROR</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a12" doxytag="SERIAL_TIMEOUT_ERROR"></a><em>SERIAL_TIMEOUT_ERROR</em> </td><td> </td></tr> <tr><td valign=top><a name="a24a13" doxytag="SERIAL_EXTENDED_ERROR"></a><em>SERIAL_EXTENDED_ERROR</em> </td><td> </td></tr> </table> </dl> </td> </tr> </table> <a name="a25" doxytag="serial.h::sioflow_t"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> enum sioflow_t </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt> <b>Enumeration values:</b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><a name="a25a14" doxytag="SERIAL_FLOW_NONE"></a><em>SERIAL_FLOW_NONE</em> </td><td> </td></tr> <tr><td valign=top><a name="a25a15" doxytag="SERIAL_FLOW_SOFT"></a><em>SERIAL_FLOW_SOFT</em> </td><td> </td></tr> <tr><td valign=top><a name="a25a16" doxytag="SERIAL_FLOW_HARD"></a><em>SERIAL_FLOW_HARD</em> </td><td> </td></tr> <tr><td valign=top><a name="a25a17" doxytag="SERIAL_FLOW_BOTH"></a><em>SERIAL_FLOW_BOTH</em> </td><td> </td></tr> </table> </dl> </td> </tr> </table> <a name="a26" doxytag="serial.h::sioparity_t"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> enum sioparity_t </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt> <b>Enumeration values:</b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><a name="a26a18" doxytag="SERIAL_PARITY_NONE"></a><em>SERIAL_PARITY_NONE</em> </td><td> </td></tr> <tr><td valign=top><a name="a26a19" doxytag="SERIAL_PARITY_ODD"></a><em>SERIAL_PARITY_ODD</em> </td><td> </td></tr> <tr><td valign=top><a name="a26a20" doxytag="SERIAL_PARITY_EVEN"></a><em>SERIAL_PARITY_EVEN</em> </td><td> </td></tr> </table> </dl> </td> </tr> </table> <a name="a27" doxytag="serial.h::siopend_t"></a><p> <table width="100%" cellpadding="2" cellspacing="0" border="0"> <tr> <td class="md"> <table cellpadding="0" cellspacing="0" border="0"> <tr> <td nowrap valign="top"><b> enum siopend_t </b></td> </tr> </table> </td> </tr> </table> <table cellspacing=5 cellpadding=0 border=0> <tr> <td> </td> <td> <p> <dl compact><dt> <b>Enumeration values:</b><dd> <table border=0 cellspacing=2 cellpadding=0> <tr><td valign=top><a name="a27a21" doxytag="SERIAL_PENDING_INPUT"></a><em>SERIAL_PENDING_INPUT</em> </td><td> </td></tr> <tr><td valign=top><a name="a27a22" doxytag="SERIAL_PENDING_OUTPUT"></a><em>SERIAL_PENDING_OUTPUT</em> </td><td> </td></tr> <tr><td valign=top><a name="a27a23" doxytag="SERIAL_PENDING_ERROR"></a><em>SERIAL_PENDING_ERROR</em> </td><td> </td></tr> </table> </dl> </td> </tr> </table> <hr><address><small>Generated at Thu Oct 4 15:32:59 2001 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.5 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>, © 1997-2001</small></address> </body> </html>