UCommon
|
A more natural C++ "ttystream" class for use by non-threaded applications. More...
#include <serial.h>
Public Member Functions | |
void | close (void) |
Close method for a tty stream. | |
void | open (const char *name) |
Open method for a tty stream. More... | |
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. More... | |
![]() | |
void | interactive (bool flag) |
Set tty mode to buffered or "interactive". More... | |
bool | isPending (Pending pend, timeout_t timeout=ucommon::Timer::inf) |
Get the status of pending operations. More... | |
void | setTimeout (timeout_t to) |
Set the timeout control. More... | |
int | sync (void) |
Flushes the stream input and out buffers, writes pending output. More... | |
TTYStream (const char *filename, timeout_t to=0) | |
Create and open a tty serial port. More... | |
virtual | ~TTYStream () |
End the tty stream and cleanup. | |
![]() | |
int | getBufferSize (void) const |
Get the "buffer" size for buffered operations. More... | |
Error | getErrorNumber (void) const |
Often used by a "catch" to fetch the last error of a thrown serial. More... | |
char * | getErrorString (void) const |
Often used by a "catch" to fetch the user set error string of a thrown serial. More... | |
Serial & | operator= (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. More... | |
Error | setFlowControl (Flow flow) |
Set flow control. More... | |
Error | setParity (Parity parity) |
Set parity mode. More... | |
Error | setSpeed (unsigned long speed) |
Set serial port speed for both input and output. More... | |
Error | setStopBits (int bits) |
Set number of stop bits. More... | |
void | toggleDTR (timeout_t millisec) |
Set the DTR mode off momentarily. More... | |
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. More... | |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
void | allocate (void) |
Used to allocate the buffer space needed for iostream operations. More... | |
void | endStream (void) |
Used to terminate the buffer space and clean up the tty connection. More... | |
int | overflow (int ch) |
This streambuf method is used to write the output buffer through the established tty port. More... | |
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. More... | |
int | underflow (void) |
This streambuf method is used to load the input buffer through the established tty serial port. More... | |
![]() | |
virtual int | aRead (char *Data, const int Length) |
Reads from serial device. More... | |
virtual int | aWrite (const char *Data, const int Length) |
Writes to serial device. More... | |
void | close (void) |
Closes the serial device. | |
void | endSerial (void) |
Used as the default destructor for ending serial I/O services. More... | |
Error | error (Error error, char *errstr=NULL) |
This service is used to throw all serial errors which usually occur during the serial constructor. More... | |
void | error (char *err) |
This service is used to thow application defined serial errors where the application specific error code is a string. More... | |
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. More... | |
void | open (const char *fname) |
Opens the serial device. More... | |
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. More... | |
void | setError (bool enable) |
This method is used to turn the error handler on or off for "throwing" execptions by manipulating the thrown flag. More... | |
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. More... | |
int | setPacketInput (int size, uint8_t btimer=0) |
Set packet read mode and "size" of packet read buffer. More... | |
void | waitOutput (void) |
Used to wait until all output has been sent. | |
![]() | |
char * | gbuf |
char * | pbuf |
timeout_t | timeout |
![]() | |
int | bufsize |
fd_t | dev |
A more natural C++ "ttystream" class for use by non-threaded applications.
This class behaves a lot more like fstream and similar classes.
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::open | ( | const char * | name | ) |
Open method for a tty stream.
name | filename to open. |