serial.h(3)

💖 serial.h(3) — it's giving "Library Functions Manual" energy ✨

okay bestie, so this is the man page for serial.h, straight out of the Library Functions Manual — GNU CommonC++ edition, no less. it's a C++ header, and it's here to give you all the serial I/O services you could ever want. let's get into it 🫶

---

✨ NAME ✨

serial.h — Serial I/O services. that's it, that's the vibe. 💅

---

🌸 SYNOPSIS 🌸

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

like, include all three, bestie. don't skip any. ✨

👑 Classes

• class ost::Serial — the blueprint, the blueprintiest blueprint. Serial is the base class for all serial I/O services under APE. everything else is basically standing on its shoulders fr fr.
• class ost::TTYStream — TTY streams are for serial connections that are fully "streamable" objects, meaning they play nice with C++ stream classes and all their friends. iconic behaviour honestly.
• class ost::ttystream — lowercase ttystream, the more natural C++ ttystream class, specifically for non-threaded applications. for the lowkey girlies who don't wanna deal with threads 🎀
• class ost::TTYSession — this one aggragates a TTYStream and a Common C++ Thread, which is assumed to be the execution context used to actually perform the I/O operations. it's a package deal 💖
• class ost::SerialPort — the serial port is an internal class that gets attached to a specified SerialService thread and then serviced by it. attached and serviced, periodt.
• class ost::SerialService — the SerialService is a thread service object whose whole job is servicing attached serial ports. it's the main character of the thread pool 🌟

🦋 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. short, sweet, and literally the entire point of this header. ✨

---

🧚 Macro Definition Documentation 🧚

#define INVALID_HANDLE_VALUE (-1)

yeah so INVALID_HANDLE_VALUE is defined as (-1). that's the whole entry. no notes. 💅

---

💀 Typedef Documentation 💀

typedef int HANDLE

HANDLE is just an int. that's it. that's the typedef. iconic minimalism, honestly 🙈

---

🎀 Author 🎀

Generated automatically by Doxygen for GNU CommonC++ from the source code. so like, not a human, a robot did this. respect. 🤖💖

---

and that's a wrap bestie!! this page came to you courtesy of GNU CommonC++, dated Sun Dec 27 2020 — so go forth, wire up those serial ports, and slay 👑🦋✨