| ost::TTYStream(3) | Library Functions Manual | ost::TTYStream(3) |
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.
TTYStream (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_t
timeout=TIMEOUT_INF)
Get the status of pending operations.
TTYStream ()
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.
char * gbuf
char * pbuf
timeout_t timeout
TTYStream & crlf (TTYStream &)
TTYStream & lfcr (TTYStream &)
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:
This constructor is used to derive 'ttystream', a more C++ style version of the TTYStream class.
Create and open a tty serial port.
Parameters:
End the tty stream and cleanup.
Used to allocate the buffer space needed for iostream operations. This is based on MAX_INPUT.
Used to terminate the buffer space and clean up the tty connection. This function is called by the destructor.
Set tty mode to buffered or 'interactive'. When interactive, all streamed I/O is directly sent to the serial port immediately.
Parameters:
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:
Parameters:
Reimplemented from ost::Serial.
This streambuf method is used to write the output buffer through the established tty port.
Parameters:
Returns:
Set the timeout control.
Parameters:
References TIMEOUT_INF.
Flushes the stream input and out buffers, writes pending output.
Returns:
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:
This streambuf method is used to load the input buffer through the established tty serial port.
Returns:
Generated automatically by Doxygen for GNU CommonC++ from the source code.
| Wed Oct 31 2018 | GNU CommonC++ |