UCommon
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 (const char *name)
 Open method for a tty stream.
 
bool operator! ()
 Test to see if stream is opened.
 
 ttystream ()
 Construct an unopened "ttystream" object.
 
 ttystream (const 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 (const 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) const
 Get the "buffer" size for buffered operations.
 
Error getErrorNumber (void) const
 Often used by a "catch" to fetch the last error of a thrown serial.
 
char * getErrorString (void) const
 Often used by a "catch" to fetch the user set error string of a thrown serial.
 
Serialoperator= (const 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 Member Functions inherited from ost::Serial
virtual int aRead (char *Data, const int Length)
 Reads from serial device.
 
virtual int aWrite (const char *Data, const int Length)
 Writes to serial device.
 
void close (void)
 Closes the serial device.
 
void endSerial (void)
 Used as the default destructor for ending serial I/O services.
 
void error (char *err)
 This service is used to thow application defined serial errors where the application specific error code is a string.
 
Error error (Error error, char *errstr=NULL)
 This service is used to throw all serial errors which usually occur during the serial constructor.
 
void flushInput (void)
 Used to flush the input waiting queue.
 
void flushOutput (void)
 Used to flush any pending output data.
 
void initConfig (void)
 Used to initialize a newly opened serial file handle.
 
void open (const char *fname)
 Opens the serial device.
 
void restore (void)
 Restore serial device to the original settings at time of open.
 
 Serial ()
 This allows later ttystream class to open and close a serial device.
 
 Serial (const char *name)
 A serial object may be constructed from a named file on the file system.
 
void setError (bool enable)
 This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag.
 
int setLineInput (char newline=13, char nl1=0)
 Set "line buffering" read mode and specifies the newline character to be used in seperating line records.
 
int setPacketInput (int size, uint8_t btimer=0)
 Set packet read mode and "size" of packet read buffer.
 
void waitOutput (void)
 Used to wait until all output has been sent.
 
- Protected Attributes inherited from ost::TTYStream
char * gbuf
 
char * pbuf
 
timeout_t timeout
 
- Protected Attributes inherited from ost::Serial
int bufsize
 
fd_t dev
 

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 542 of file serial.h.

Constructor & Destructor Documentation

◆ ttystream()

ost::ttystream::ttystream ( const 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
nameof file and serial options.

Member Function Documentation

◆ open()

void ost::ttystream::open ( const char * name)

Open method for a tty stream.

Parameters
namefilename to open.

◆ operator!()

bool ost::ttystream::operator! ( )
inline

Test to see if stream is opened.

Definition at line 577 of file serial.h.


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