47#ifndef CCXX_MISSING_H_
55#ifndef CCXX_EXCEPTION_H_
61#define INVALID_HANDLE_VALUE (-1)
156 void initSerial(
void);
184 virtual int aRead(
char * Data,
const int Length);
192 virtual int aWrite(
const char * Data,
const int Length);
210 {
error(errExtended, err);};
220 {flags.thrown = !enable;};
641 bool detect_disconnect;
670 {
return detect_pending; }
682 {
return detect_output; }
713 {
return aWrite((
char *)buf, len);};
729 inline int input(
void *buf,
int len)
730 {
return aRead((
char *)buf, len);};
865#ifdef COMMON_STD_EXCEPTION
866class __EXPORT SerException :
public IOException
869 SerException(
const String &str) : IOException(str) {};
873#ifdef CCXX_NAMESPACES
The Mutex class is used to protect a section of code so that at any given time only a single thread c...
Definition thread.h:187
The Serial class is used as the base for all serial I/O services under APE.
Definition serial.h:99
void restore(void)
Restore serial device to the original settings at time of open.
enum Flow Flow
Definition serial.h:125
bool thrown
Definition serial.h:146
virtual int aWrite(const char *Data, const int Length)
Writes to serial device.
HANDLE dev
Definition serial.h:160
enum Error Error
Definition serial.h:117
void flushInput(void)
Used to flush the input waiting queue.
void setError(bool enable)
This method is used to turn the error handler on or off for "throwing" execptions by manipulating the...
Definition serial.h:219
Flow
Definition serial.h:119
@ flowNone
Definition serial.h:120
@ flowSoft
Definition serial.h:121
@ flowHard
Definition serial.h:122
Error error(Error error, char *errstr=NULL)
This service is used to throw all serial errors which usually occur during the serial constructor.
Serial()
This allows later ttystream class to open and close a serial device.
Definition serial.h:282
Error
Definition serial.h:101
@ errCharsizeInvalid
Definition serial.h:108
@ errInput
Definition serial.h:113
@ errOutput
Definition serial.h:112
@ errOptionInvalid
Definition serial.h:110
@ errStopbitsInvalid
Definition serial.h:109
@ errSpeedInvalid
Definition serial.h:105
@ errFlowInvalid
Definition serial.h:106
@ errResourceFailure
Definition serial.h:111
@ errTimeout
Definition serial.h:114
@ errParityInvalid
Definition serial.h:107
@ errOpenNoTty
Definition serial.h:103
@ errOpenFailed
Definition serial.h:104
void toggleDTR(timeout_t millisec)
Set the DTR mode off momentarily.
Parity
Definition serial.h:127
@ parityOdd
Definition serial.h:129
@ parityNone
Definition serial.h:128
Error setParity(Parity parity)
Set parity mode.
Error setFlowControl(Flow flow)
Set flow control.
void initConfig(void)
Used to initialize a newly opened serial file handle.
int bufsize
Definition serial.h:162
Pending
Definition serial.h:134
@ pendingInput
Definition serial.h:135
@ pendingOutput
Definition serial.h:136
enum Pending Pending
Definition serial.h:139
Serial & operator=(const Serial &from)
Serial ports may also be duplecated by the assignment operator.
virtual bool isPending(Pending pend, timeout_t timeout=TIMEOUT_INF)
Get the status of pending operations.
int setLineInput(char newline=13, char nl1=0)
Set "line buffering" read mode and specifies the newline character to be used in seperating line reco...
void error(char *err)
This service is used to thow application defined serial errors where the application specific error c...
Definition serial.h:209
virtual ~Serial()
The serial base class may be "thrown" as a result on an error, and the "catcher" may then choose to d...
virtual int aRead(char *Data, const int Length)
Reads from serial device.
void open(const char *fname)
Opens the serial device.
Serial(const char *name)
A serial object may be constructed from a named file on the file system.
void close(void)
Closes the serial device.
Error setSpeed(unsigned long speed)
Set serial port speed for both input and output.
Error getErrorNumber(void)
Often used by a "catch" to fetch the last error of a thrown serial.
Definition serial.h:368
void flushOutput(void)
Used to flush any pending output data.
void waitOutput(void)
Used to wait until all output has been sent.
char * getErrorString(void)
Often used by a "catch" to fetch the user set error string of a thrown serial.
Definition serial.h:377
Error setCharBits(int bits)
Set character size.
void sendBreak(void)
Send the "break" signal.
int getBufferSize(void)
Get the "buffer" size for buffered operations.
Definition serial.h:387
Error setStopBits(int bits)
Set number of stop bits.
void endSerial(void)
Used as the default destructor for ending serial I/O services.
enum Parity Parity
Definition serial.h:132
int setPacketInput(int size, unsigned char btimer=0)
Set packet read mode and "size" of packet read buffer.
bool linebuf
Definition serial.h:147
The serial port is an internal class which is attached to and then serviced by a specified SerialServ...
Definition serial.h:632
virtual ~SerialPort()
Disconnect the Serial Port from the service pool thread and shutdown the port.
void setDetectOutput(bool)
Used to indicate if output ready monitoring should be performed by the service thread.
int output(void *buf, int len)
Transmit "send" data to the serial port.
Definition serial.h:712
bool getDetectOutput(void) const
Get the current state of the DetectOutput flag.
Definition serial.h:681
virtual void pending(void)
Called by the service thread when input data is pending for this tty port.
void incTimer(timeout_t timeout)
Derived incTimer to notify the service thread pool of a change in expected timeout.
virtual void expired(void)
Called by the service thread when the objects timer has expired.
SerialPort(SerialService *svc, const char *name)
Construct a tty serial port for a named serial device.
void setDetectPending(bool)
Used to indicate if the service thread should monitor pending data for us.
virtual void disconnect(void)
Called by the service thread when an exception has occured such as a hangup.
bool getDetectPending(void) const
Get the current state of the DetectPending flag.
Definition serial.h:669
void setTimer(timeout_t timeout=0)
Derived setTimer to notify the service thread pool of changes in expected timeout.
int input(void *buf, int len)
Receive "input" for pending data from the serial port.
Definition serial.h:729
virtual void output(void)
Perform when output is available for sending data.
The SerialService is a thead service object that is meant to service attached serial ports.
Definition serial.h:772
virtual void onUpdate(unsigned char flag)
A virtual handler for processing user defined update requests (1-254) which have been posted through ...
virtual ~SerialService()
Terminate the service thread and update attached objects.
void update(unsigned char flag=0xff)
Notify service thread that a port has been added or removed, or a timer changed, so that a new schedu...
virtual void onEvent(void)
A virtual handler for event loop calls.
SerialService(int pri=0, size_t stack=0, const char *id=NULL)
Create a service thread for attaching serial ports.
int getCount(void)
Get current reference count.
Definition serial.h:857
virtual void onCallback(SerialPort *port)
A virtual handler for adding support for additional callback events into SerialPort.
The TTYSession aggragates a TTYStream and a Common C++ Thread which is assumed to be the execution co...
Definition serial.h:589
TTYSession(const char *name, int pri=0, int stack=0)
Create TTY stream that will be managed by it's own thread.
TTY streams are used to represent serial connections that are fully "streamable" objects using C++ st...
Definition serial.h:424
void interactive(bool flag)
Set tty mode to buffered or "interactive".
char * gbuf
Definition serial.h:432
void setTimeout(timeout_t to)
Set the timeout control.
Definition serial.h:499
bool isPending(Pending pend, timeout_t timeout=TIMEOUT_INF)
Get the status of pending operations.
int uflow(void)
This streambuf method is used for doing unbuffered reads through the establish tty serial port when i...
friend TTYStream & lfcr(TTYStream &)
void allocate(void)
Used to allocate the buffer space needed for iostream operations.
TTYStream(const char *filename, timeout_t to=0)
Create and open a tty serial port.
TTYStream()
This constructor is used to derive "ttystream", a more C++ style version of the TTYStream class.
int underflow(void)
This streambuf method is used to load the input buffer through the established tty serial port.
int overflow(int ch)
This streambuf method is used to write the output buffer through the established tty port.
friend TTYStream & crlf(TTYStream &)
timeout_t timeout
Definition serial.h:433
void endStream(void)
Used to terminate the buffer space and clean up the tty connection.
virtual ~TTYStream()
End the tty stream and cleanup.
int sync(void)
Flushes the stream input and out buffers, writes pending output.
Every thread of execution in an application is created by instantiating an object of a class derived ...
Definition thread.h:1094
Timer ports are used to provide synchronized timing events when managed under a "service thread" such...
Definition thread.h:1760
A more natural C++ "ttystream" class for use by non-threaded applications.
Definition serial.h:543
ttystream(const char *name)
Construct and "open" a tty stream object.
void close(void)
Close method for a tty stream.
bool operator!()
Test to see if stream is opened.
Definition serial.h:574
void open(const char *name)
Open method for a tty stream.
ttystream()
Construct an unopened "ttystream" object.
#define __EXPORT
Definition config.h:1045
GNU Common C++ exception model base classes.
substitute functions which may be missing in target platform libc.
__EXPORT AppLog & error(AppLog &sl)
Manipulator for error level.
Definition applog.h:541
int HANDLE
Definition serial.h:60
Synchronization and threading services.
#define TIMEOUT_INF
Definition thread.h:115
unsigned long timeout_t
Definition thread.h:74