ost::TTYStream - TTY streams are used to represent serial connections that are fully 'streamable' objects

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

GNU CommonC++                                    Sun Dec 27 2020                               ost::TTYStream(3)

ost::TTYStream::TTYStream()[protected]
       This constructor is used to derive 'ttystream', a more C++ style version of the TTYStream class.

   ost::TTYStream::TTYStream(constchar*filename,timeout_tto=0)
       Create and open a tty serial port.

       Parametersfilename char name of device to open.
           to default timeout.

   virtualost::TTYStream::~TTYStream()[virtual]
       End the tty stream and cleanup.

       TTY streams are used to represent serial connections that are fully 'streamable' objects using C++ stream
       classes and friends.

       The first application relevant serial I/O class is the TTYStream class. TTYStream offers a linearly
       buffered 'streaming' I/O session with the serial device. Furthermore, traditional C++ 'stream' operators
       (<< and >>) may be used with the serial device. A more 'true' to ANSI C++ library format 'ttystream' is
       also available, and this supports an 'open' method in which one can pass initial serial device parameters
       immediately following the device name in a single string, as in '/dev/tty3a:9600,7,e,1', as an example.

       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.

       Author
           David Sugar dyfet@ostel.com

       streamable tty serial I/O class.

TTYStream&crlf(TTYStream&)[friend]TTYStream&lfcr(TTYStream&)[friend]

char*ost::TTYStream::gbuf[protected]char*ost::TTYStream::pbuf[protected]timeout_tost::TTYStream::timeout[protected]

voidost::TTYStream::allocate(void)[protected]
       Used to allocate the buffer space needed for iostream operations. This is based on MAX_INPUT.

   voidost::TTYStream::endStream(void)[protected]
       Used to terminate the buffer space and clean up the tty connection. This function is called by the
       destructor.

   voidost::TTYStream::interactive(boolflag)
       Set tty mode to buffered or 'interactive'. When interactive, all streamed I/O is directly sent to the
       serial port immediately.

       Parametersflag bool set to true to make interactive.

   boolost::TTYStream::isPending(Pendingpend,timeout_ttimeout=TIMEOUT_INF)[virtual]
       Get the status of pending operations. This can be used to examine if input or output is waiting, or if an
       error has occured on the serial device. If read buffer contains data then input is ready and if write
       buffer contains data it is first flushed then checked.

       Returns
           true if ready, false if timeout.

       Parameterspend ready check to perform.
           timeout in milliseconds.

       Reimplemented from ost::Serial.

   intost::TTYStream::overflow(intch)[protected]
       This streambuf method is used to write the output buffer through the established tty port.

       Parametersch char to push through.

       Returns
           char pushed through.

   voidost::TTYStream::setTimeout(timeout_tto)[inline]
       Set the timeout control.

       Parametersto timeout to use.

   intost::TTYStream::sync(void)
       Flushes the stream input and out buffers, writes pending output.

       Returns
           0 on success.

   intost::TTYStream::uflow(void)[protected]
       This streambuf method is used for doing unbuffered reads through the establish tty serial port when in
       interactive mode. Also this method will handle proper use of buffers if not in interative mode.

       Returns
           char from tty serial port, EOF also possible.

   intost::TTYStream::underflow(void)[protected]
       This streambuf method is used to load the input buffer through the established tty serial port.

       Returns
           char from get buffer, EOF also possible.

       ost::TTYStream - TTY streams are used to represent serial connections that are fully 'streamable' objects
       using C++ stream classes and friends.

       #include <serial.h>

       Inherits streambuf, ost::Serial, and iostream.

       Inherited by ost::TTYSession, and ost::ttystream.

   PublicMemberFunctionsTTYStream (const char *filename, timeout_t to=0)
           Create and open a tty serial port.
       virtual ~TTYStream ()
           End the tty stream and cleanup.
       void setTimeout (timeout_t to)
           Set the timeout control.
       void interactive (bool flag)
           Set tty mode to buffered or 'interactive'.
       int sync (void)
           Flushes the stream input and out buffers, writes pending output.
       bool isPending (Pending pend, timeout_ttimeout=TIMEOUT_INF)
           Get the status of pending operations.

   ProtectedMemberFunctionsTTYStream ()
           This constructor is used to derive 'ttystream', a more C++ style version of the TTYStream class.
       void allocate (void)
           Used to allocate the buffer space needed for iostream operations.
       void endStream (void)
           Used to terminate the buffer space and clean up the tty connection.
       int underflow (void)
           This streambuf method is used to load the input buffer through the established tty serial port.
       int uflow (void)
           This streambuf method is used for doing unbuffered reads through the establish tty serial port when
           in interactive mode.
       int overflow (int ch)
           This streambuf method is used to write the output buffer through the established tty port.

   ProtectedAttributes
       char * gbuf
       char * pbuftimeout_ttimeoutFriendsTTYStream & crlf (TTYStream &)
       TTYStream & lfcr (TTYStream &)

   AdditionalInheritedMembers