---
name: "serial.h"
section: "3"
platform: "linux"
package: "libcommoncpp2-doc"
version: "1.8.1-10"
release: "Debian 11 (Bullseye)"
platforms: ["linux"]
url: "https://new.carta.tech/serial.h"
---

# serial.h(3)

Serial I/O services.

## NAME

serial.h - Serial I/O services.

## SYNOPSIS

`#include <cc++/missing.h>`\
 `#include <cc++/thread.h>`\
 `#include <cc++/exception.h>`\

### Classes

class **ost::Serial**\
 The **Serial** class is used as the base for all serial I/O services under APE.  class **ost::TTYStream**\
 TTY streams are used to represent serial connections that are fully 'streamable' objects using C++ stream classes and friends.  class **ost::ttystream**\
 A more natural C++ 'ttystream' class for use by non-threaded applications.  class **ost::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.  class **ost::SerialPort**\
 The serial port is an internal class which is attached to and then serviced by a specified **SerialService** thread.  class **ost::SerialService**\
 The **SerialService** is a thead service object that is meant to service attached serial ports.

### Namespaces

 **ost**\

### Macros

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

### Typedefs

typedef int **HANDLE**\

### Variables

class **\_\_EXPORT** **ost::SerialPort**\
 class **\_\_EXPORT** **ost::SerialService**\

## Detailed Description

Serial I/O services.

## Macro Definition Documentation

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

## Typedef Documentation

### typedef int HANDLE

## Author

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