<!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"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>GNU CommonC++: serial.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU CommonC++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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><a href="annotated.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>File Members</span></a></li> </ul> </div> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_bfccd401955b95cf8c75461437045ac0.html">inc</a></li><li class="navelem"><a class="el" href="dir_6b3e09e31d3da6038137f0238e9fb19b.html">cc++</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#namespaces">Namespaces</a> | <a href="#define-members">Macros</a> | <a href="#typedef-members">Typedefs</a> | <a href="#var-members">Variables</a> </div> <div class="headertitle"> <div class="title">serial.h File Reference</div> </div> </div><!--header--> <div class="contents"> <p>Serial I/O services. <a href="#details">More...</a></p> <div class="textblock"><code>#include <<a class="el" href="missing_8h_source.html">cc++/missing.h</a>></code><br/> <code>#include <<a class="el" href="thread_8h_source.html">cc++/thread.h</a>></code><br/> <code>#include <<a class="el" href="exception_8h_source.html">cc++/exception.h</a>></code><br/> </div> <p><a href="serial_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial.html">ost::Serial</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_serial.html" title="The Serial class is used as the base for all serial I/O services under APE. ">Serial</a> class is used as the base for all serial I/O services under APE. <a href="classost_1_1_serial.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_t_y_stream.html">ost::TTYStream</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">TTY streams are used to represent serial connections that are fully "streamable" objects using C++ stream classes and friends. <a href="classost_1_1_t_t_y_stream.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1ttystream.html">ost::ttystream</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">A more natural C++ "ttystream" class for use by non-threaded applications. <a href="classost_1_1ttystream.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_t_t_y_session.html">ost::TTYSession</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_t_t_y_session.html" title="The TTYSession aggragates a TTYStream and a Common C++ Thread which is assumed to be the execution co...">TTYSession</a> aggragates a <a class="el" href="classost_1_1_t_t_y_stream.html" title="TTY streams are used to represent serial connections that are fully "streamable" objects using C++ st...">TTYStream</a> and a Common C++ <a class="el" href="classost_1_1_thread.html" title="Every thread of execution in an application is created by instantiating an object of a class derived ...">Thread</a> which is assumed to be the execution context that will be used to perform actual I/O operations. <a href="classost_1_1_t_t_y_session.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_port.html">ost::SerialPort</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">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" title="The SerialService is a thead service object that is meant to service attached serial ports...">SerialService</a> thread. <a href="classost_1_1_serial_port.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_serial_service.html">ost::SerialService</a></td></tr> <tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">The <a class="el" href="classost_1_1_serial_service.html" title="The SerialService is a thead service object that is meant to service attached serial ports...">SerialService</a> is a thead service object that is meant to service attached serial ports. <a href="classost_1_1_serial_service.html#details">More...</a><br/></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="namespaces"></a> Namespaces</h2></td></tr> <tr class="memitem:namespaceost"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html">ost</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a> Macros</h2></td></tr> <tr class="memitem:a5fdc7facea201bfce4ad308105f88d0c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a5fdc7facea201bfce4ad308105f88d0c">INVALID_HANDLE_VALUE</a>   (-1)</td></tr> <tr class="separator:a5fdc7facea201bfce4ad308105f88d0c"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr class="memitem:a069bb8cb95b0528d5ce0304bb5561a40"><td class="memItemLeft" align="right" valign="top">typedef int </td><td class="memItemRight" valign="bottom"><a class="el" href="serial_8h.html#a069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a></td></tr> <tr class="separator:a069bb8cb95b0528d5ce0304bb5561a40"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a> Variables</h2></td></tr> <tr class="memitem:a9efc8cc6866dd331e5f21c2a816ca6d2"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#a9efc8cc6866dd331e5f21c2a816ca6d2">ost::SerialPort</a></td></tr> <tr class="separator:a9efc8cc6866dd331e5f21c2a816ca6d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a499e7de437b403177426e5066d84b306"><td class="memItemLeft" align="right" valign="top">class <a class="el" href="config_8h.html#ad10ef148ba8327bd530fc6c32c1e181c">__EXPORT</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceost.html#a499e7de437b403177426e5066d84b306">ost::SerialService</a></td></tr> <tr class="separator:a499e7de437b403177426e5066d84b306"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Serial I/O services. </p> </div><h2 class="groupheader">Macro Definition Documentation</h2> <a class="anchor" id="a5fdc7facea201bfce4ad308105f88d0c"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define INVALID_HANDLE_VALUE   (-1)</td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Typedef Documentation</h2> <a class="anchor" id="a069bb8cb95b0528d5ce0304bb5561a40"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int <a class="el" href="serial_8h.html#a069bb8cb95b0528d5ce0304bb5561a40">HANDLE</a></td> </tr> </table> </div><div class="memdoc"> </div> </div> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>