|
GNU CommonC++
|
A more natural C++ "ttystream" class for use by non-threaded applications. More...
#include <serial.h>
Public Member Functions | |
| ttystream () | |
| Construct an unopened "ttystream" object. | |
| ttystream (const char *name) | |
| Construct and "open" a tty stream object. | |
| void | open (const char *name) |
| Open method for a tty stream. | |
| void | close (void) |
| Close method for a tty stream. | |
| bool | operator! () |
| Test to see if stream is opened. | |
Public Member Functions inherited from 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. | |
Public Member Functions inherited from ost::Serial | |
| 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. | |
| Serial & | operator= (const Serial &from) |
| Serial ports may also be duplecated by the assignment operator. | |
| Error | setSpeed (unsigned long speed) |
| Set serial port speed for both input and output. | |
| Error | setCharBits (int bits) |
| Set character size. | |
| Error | setParity (Parity parity) |
| Set parity mode. | |
| Error | setStopBits (int bits) |
| Set number of stop bits. | |
| Error | setFlowControl (Flow flow) |
| Set flow control. | |
| void | toggleDTR (timeout_t millisec) |
| Set the DTR mode off momentarily. | |
| void | sendBreak (void) |
| Send the "break" signal. | |
| 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. | |
| int | getBufferSize (void) |
| Get the "buffer" size for buffered operations. | |
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 } |
| enum | Flow { flowNone , flowSoft , flowHard , flowBoth } |
| enum | Parity { parityNone , parityOdd , parityEven } |
| enum | Pending { pendingInput , pendingOutput , pendingError } |
| typedef enum Error | Error |
| typedef enum Flow | Flow |
| typedef enum Parity | Parity |
| typedef enum Pending | Pending |
Protected Member Functions inherited from ost::TTYStream | |
| 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. | |
Protected Member Functions inherited from ost::Serial | |
| void | open (const char *fname) |
| Opens the serial device. | |
| void | close (void) |
| Closes the serial device. | |
| 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. | |
| Error | error (Error error, char *errstr=NULL) |
| This service is used to throw all serial errors which usually occur during the serial constructor. | |
| void | error (char *err) |
| This service is used to thow application defined serial errors where the application specific error code is a string. | |
| 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 | setPacketInput (int size, unsigned char btimer=0) |
| Set packet read mode and "size" of packet read buffer. | |
| 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. | |
| void | restore (void) |
| Restore serial device to the original settings at time of open. | |
| void | flushInput (void) |
| Used to flush the input waiting queue. | |
| void | flushOutput (void) |
| Used to flush any pending output data. | |
| void | waitOutput (void) |
| Used to wait until all output has been sent. | |
| void | endSerial (void) |
| Used as the default destructor for ending serial I/O services. | |
| void | initConfig (void) |
| Used to initialize a newly opened serial file handle. | |
| 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. | |
Protected Attributes inherited from ost::TTYStream | |
| char * | gbuf |
| char * | pbuf |
| timeout_t | timeout |
Protected Attributes inherited from ost::Serial | |
| HANDLE | dev |
| int | bufsize |
A more natural C++ "ttystream" class for use by non-threaded applications.
This class behaves a lot more like fstream and similar classes.
C++ "fstream" style ttystream class.
| ost::ttystream::ttystream | ( | ) |
Construct an unopened "ttystream" object.
| 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.
| name | of file and serial options. |
| void ost::ttystream::close | ( | void | ) |
Close method for a tty stream.
| void ost::ttystream::open | ( | const char * | name | ) |
Open method for a tty stream.
| name | filename to open. |
|
inline |
Test to see if stream is opened.