ost::ttystream Class Reference

A more natural C++ "ttystream" class for use by non-threaded applications. More...

#include <serial.h>

Inheritance diagram for ost::ttystream:

Collaboration diagram for ost::ttystream:

Public Member Functions
void	close (void)
	Close method for a tty stream.
void	open (char *name)
	Open method for a tty stream.
bool	operator! ()
	Test to see if stream is opened.
	ttystream ()
	Construct an unopened "ttystream" object.
	ttystream (char *name)
	Construct and "open" a tty stream object.
Public Member Functions inherited from ost::TTYStream
void	interactive (bool flag)
	Set tty mode to buffered or "interactive".
bool	isPending (Pending pend, timeout_t timeout=ucommon::Timer::inf)
	Get the status of pending operations.
void	setTimeout (timeout_t to)
	Set the timeout control.
int	sync (void)
	Flushes the stream input and out buffers, writes pending output.
	TTYStream (char *filename, timeout_t to=0)
	Create and open a tty serial port.
virtual	~TTYStream ()
	End the tty stream and cleanup.
Public Member Functions inherited from ost::Serial
int	getBufferSize (void)
	Get the "buffer" size for buffered operations.
Error	getErrorNumber (void)
	Often used by a "catch" to fetch the last error of a thrown serial.
char *	getErrorString (void)
	Often used by a "catch" to fetch the user set error string of a thrown serial.
Serial &	operator= (Serial &from)
	Serial ports may also be duplecated by the assignment operator.
void	sendBreak (void)
	Send the "break" signal.
Error	setCharBits (int bits)
	Set character size.
Error	setFlowControl (Flow flow)
	Set flow control.
Error	setParity (Parity parity)
	Set parity mode.
Error	setSpeed (unsigned long speed)
	Set serial port speed for both input and output.
Error	setStopBits (int bits)
	Set number of stop bits.
void	toggleDTR (timeout_t millisec)
	Set the DTR mode off momentarily.
virtual	~Serial ()
	The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to destory the object.

Additional Inherited Members
Public Types inherited from ost::Serial
enum	Error {   errSuccess = 0, errOpenNoTty, errOpenFailed, errSpeedInvalid,   errFlowInvalid, errParityInvalid, errCharsizeInvalid, errStopbitsInvalid,   errOptionInvalid, errResourceFailure, errOutput, errInput,   errTimeout, errExtended }
typedef enum Error	Error
enum	Flow { flowNone, flowSoft, flowHard, flowBoth }
typedef enum Flow	Flow
enum	Parity { parityNone, parityOdd, parityEven }
typedef enum Parity	Parity
enum	Pending { pendingInput, pendingOutput, pendingError }
typedef enum Pending	Pending
Protected Member Functions inherited from ost::TTYStream
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	overflow (int ch)
	This streambuf method is used to write the output buffer through the established tty port.
	TTYStream ()
	This constructor is used to derive "ttystream", a more C++ style version of the TTYStream class.
int	uflow (void)
	This streambuf method is used for doing unbuffered reads through the establish tty serial port when in interactive mode.
int	underflow (void)
	This streambuf method is used to load the input buffer through the established tty serial port.
Protected Attributes inherited from ost::TTYStream
char *	gbuf
char *	pbuf
timeout_t	timeout

Detailed Description

A more natural C++ "ttystream" class for use by non-threaded applications.

This class behaves a lot more like fstream and similar classes.

Author

David Sugar dyfet.nosp@m.@ost.nosp@m.el.co.nosp@m.m C++ "fstream" style ttystream class.

Definition at line 535 of file serial.h.

Constructor & Destructor Documentation

ost::ttystream::ttystream

(

char *

name

)

Construct and "open" a tty stream object.

A filename in the form "device:options[,options]" may be used to pass device options as part of the open.

Parameters

name	of file and serial options.

Member Function Documentation

void ost::ttystream::open

(

char *

name

)

Open method for a tty stream.

Parameters

name	filename to open.

Reimplemented from ost::Serial.

---

The documentation for this class was generated from the following file:

• commoncpp/serial.h