ost::TTYSession(3)

📦 version 1.8.1, in ubuntu jammy

💖 ost::TTYSession 💖

okay bestie, so we're looking at a page from the GNU CommonC++ library functions manual, and honestly? this one's a little baddie. it's ost::TTYSession(3) and she's giving "I run my own thread and I do my own I/O" energy. periodt. 💅

✨ NAME ✨

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.

like. she's the whole package. stream + thread, glued together, doing the most. 🫶

🌸 SYNOPSIS 🌸

#include <serial.h>

Inherits ost::Thread, and ost::TTYStream.

🎀 Public Member Functions 🎀

  • TTYSession (const char *name, int pri=0, int stack=0) — Create TTY stream that will be managed by it's own thread.
  • virtual ~TTYSession ()

🦋 Additional Inherited Members 🦋

(no cap, there's more stuff she got from her parents — you'll wanna peek at the inherited members when you need them 💜)

👑 DESCRIPTION 👑

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.

lowkey the most iconic sentence on the whole page: she is very anagolous to TCPSession. if you already know TCPSession, bestie, you already know her. iykyk. 😌

🧚 AUTHOR 🧚

David Sugar dyfet@ostel.com

This class is very anagolous to TCPSession.

(yes she said it twice. she's consistent. she's committed. we love that for her. ✨)

💅 CONSTRUCTOR & DESTRUCTOR DOCUMENTATION 💅

🌈 ost::TTYSession::TTYSession (const char * name, int pri = 0, int stack = 0)

Create TTY stream that will be managed by it's own thread.

Parameters

  • name — of tty device to open.
  • pri — execution priority.
  • stack — allocation needed on some platforms.

so like, you hand her the tty device name, you tell her the priority pri, and on some platforms you gotta cough up a stack allocation too. main character setup fr fr. 🍓

⭐ virtual ost::TTYSession::~TTYSession () [virtual]

and that's it. that's the destructor. she cleans up after herself, no drama, no notes. 💀

💜 AUTHOR 💜

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

okay that's the whole page bestie, you ate that. this was GNU CommonC++, dated Sun Dec 27 2020, and the manual page you just read was ost::TTYSession(3). go forth and open your tty devices responsibly 🎀💖✨

📦 where this page comes from