---
name: "serial.h"
section: "3cc"
platform: "linux"
package: "libcommoncpp2-dev"
version: "1.0.13-5"
release: "Debian 3.1 (Sarge)"
platforms: ["linux"]
url: "https://new.carta.tech/serial.h/3cc"
---

# serial.h(3cc)

Serial I/O services.

## NAME

serial.h - **Serial** I/O services.

## SYNOPSIS

`#include <cc++/config.h>`\
 `#include <cc++/thread.h>`\
 `#include <iostream>`\

### Compounds

class **Serial**\
 *The Serial class is used as the base for all serial I/O services under APE. base class for all serial I/O services.* class **SerialPort**\
 *The serial port is an internal class which is attached to and then serviced by a specified* **SerialService** *thread. base class for thread pool serviced serial I/O.* class **SerialService**\
 *The SerialService is a thead service object that is meant to service attached serial ports.* **Thread** *pool service for serial ports.* class **TTYSession**\
 *The TTYSession aggragates a* **TTYStream** *and a Common C++* **Thread** *which is assumed to be the execution context that will be used to perform actual I/O operations. This class is very anagolous to* **TCPSession***.* class **ttystream**\
 *A more natural C++ 'ttystream' class for use by non-threaded applications. C++ 'fstream' style ttystream class.* class **TTYStream**\
 *TTY streams are used to represent serial connections that are fully 'streamable' objects using C++ stream classes and friends. streamable tty serial I/O class.*

### Defines

\#define **INVALID\_HANDLE\_VALUE**   (-1)\

### Typedefs

typedef int **HANDLE**\

### Variables

CCXX\_CLASS\_EXPORT **Serial**\
 CCXX\_CLASS\_EXPORT **TTYStream**\
 CCXX\_CLASS\_EXPORT **ttystream**\

## DETAILED DESCRIPTION

**Serial** I/O services.

## DEFINE DOCUMENTATION

### #define INVALID\_HANDLE\_VALUE (-1)

## TYPEDEF DOCUMENTATION

### typedef int HANDLE

## VARIABLE DOCUMENTATION

### class CCXX\_CLASS\_EXPORT Serial

### class CCXX\_CLASS\_EXPORT ttystream

### class CCXX\_CLASS\_EXPORT TTYStream

## AUTHOR

Generated automatically by Doxygen for CommonC++ from the source code.