.TH "serial.h" 3 "Sun Dec 27 2020" "GNU CommonC++" \" -*- nroff -*-
.ad l
.nh
.SH NAME
serial.h \- Serial I/O services\&.  

.SH SYNOPSIS
.br
.PP
\fC#include <cc++/missing\&.h>\fP
.br
\fC#include <cc++/thread\&.h>\fP
.br
\fC#include <cc++/exception\&.h>\fP
.br

.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBost::Serial\fP"
.br
.RI "The \fBSerial\fP class is used as the base for all serial I/O services under APE\&. "
.ti -1c
.RI "class \fBost::TTYStream\fP"
.br
.RI "TTY streams are used to represent serial connections that are fully 'streamable' objects using C++ stream classes and friends\&. "
.ti -1c
.RI "class \fBost::ttystream\fP"
.br
.RI "A more natural C++ 'ttystream' class for use by non-threaded applications\&. "
.ti -1c
.RI "class \fBost::TTYSession\fP"
.br
.RI "The \fBTTYSession\fP aggragates a \fBTTYStream\fP and a Common C++ \fBThread\fP which is assumed to be the execution context that will be used to perform actual I/O operations\&. "
.ti -1c
.RI "class \fBost::SerialPort\fP"
.br
.RI "The serial port is an internal class which is attached to and then serviced by a specified \fBSerialService\fP thread\&. "
.ti -1c
.RI "class \fBost::SerialService\fP"
.br
.RI "The \fBSerialService\fP is a thead service object that is meant to service attached serial ports\&. "
.in -1c
.SS "Namespaces"

.in +1c
.ti -1c
.RI " \fBost\fP"
.br
.in -1c
.SS "Macros"

.in +1c
.ti -1c
.RI "#define \fBINVALID_HANDLE_VALUE\fP   (\-1)"
.br
.in -1c
.SS "Typedefs"

.in +1c
.ti -1c
.RI "typedef int \fBHANDLE\fP"
.br
.in -1c
.SS "Variables"

.in +1c
.ti -1c
.RI "class \fB__EXPORT\fP \fBost::SerialPort\fP"
.br
.ti -1c
.RI "class \fB__EXPORT\fP \fBost::SerialService\fP"
.br
.in -1c
.SH "Detailed Description"
.PP 
Serial I/O services\&. 


.SH "Macro Definition Documentation"
.PP 
.SS "#define INVALID_HANDLE_VALUE   (\-1)"

.SH "Typedef Documentation"
.PP 
.SS "typedef int \fBHANDLE\fP"

.SH "Author"
.PP 
Generated automatically by Doxygen for GNU CommonC++ from the source code\&.