The TTYSession aggragates a TTYStream and a Common C++ Thread which is assumed to be the execution context that will be used to perform actual I/O operations. More...
#include <serial.h>
Inheritance diagram for ost::TTYSession:
Collaboration diagram for ost::TTYSession:
Public Member Functions | |
| TTYSession (const char *name, int pri=0, int stack=0) | |
| Create TTY stream that will be managed by it's own thread. More... | |
 Public Member Functions inherited from ost::Thread | |
| void | detach (void) |
| void | exit (void) |
| virtual void | final (void) |
| void | finalize (void) |
| pthread_t | getId (void) const |
| Get the thread id. | |
| virtual void | initial (void) |
| bool | isRunning (void) |
| bool | isThread (void) |
| void | join (void) |
| void | map (void) |
| virtual void | notify (Thread *thread) |
| virtual void | run (void)=0 |
| void | start (void) |
| void | sync (void) |
| void | terminate (void) |
| Thread (int pri=0, size_t stack=0) | |
| Public Member Functions inherited from ost::TTYStream | |
| 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. | |
| Public Member Functions inherited from ost::Serial | |
| 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 | |
| Public Types inherited from ost::Thread | |
| enum | Throw { throwNothing, throwObject, throwException } |
| How to raise error. | |
| typedef enum ost::Thread::Throw | Throw |
| How to raise error. | |
| 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 |
| Static Public Member Functions inherited from ost::Thread | |
| static Thread * | get (void) |
| static Throw | getException (void) |
| Get exception mode of the current thread. More... | |
| static void | setException (Throw mode) |
| Set exception mode of the current thread. More... | |
| static void | sleep (timeout_t msec=ucommon::Timer::inf) |
| static void | yield (void) |
| Protected Member Functions inherited from ucommon::JoinableThread | |
| void | background (void) |
| Start execution of child context as background thread. More... | |
| void | start (int priority=0) |
| Start execution of child context. More... | |
| bool | is_active (void) const |
| Check if running. | |
| void | join (void) |
| Join thread with parent. More... | |
| JoinableThread (size_t size=0) | |
| Create a joinable thread with a known context stack size. More... | |
| virtual void | run (void)=0 |
| Abstract interface for thread context run method. | |
| virtual | ~JoinableThread () |
| Delete child thread. More... | |
| Protected Member Functions inherited from ost::TTYStream | |
| 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... | |
| Static Protected Member Functions inherited from ucommon::Thread | |
| static size_t | cache (void) |
| Get cache line size. | |
| static void | concurrency (int level) |
| Set concurrency level of process. More... | |
| static bool | equal (pthread_t thread1, pthread_t thread2) |
| Determine if two thread identifiers refer to the same thread. More... | |
| static Thread * | get (void) |
| Get mapped thread object. More... | |
| static void | init (void) |
| Used to initialize threading library. More... | |
| static void | policy (int polid) |
| Used to specify scheduling policy for threads above priority "0". More... | |
| static void | release (void) |
| static pthread_t | self (void) |
| Get current thread id. More... | |
| static void | sleep (timeout_t timeout) |
| Sleep current thread for a specified time period. More... | |
| static void | yield (void) |
| Yield execution context of the current thread. More... | |
| Protected Attributes inherited from ost::TTYStream | |
| char * | gbuf |
| char * | pbuf |
| timeout_t | timeout |
Detailed Description
The TTYSession aggragates a TTYStream and a Common C++ Thread which is assumed to be the execution context that will be used to perform actual I/O operations.
This class is very anagolous to TCPSession.
Constructor & Destructor Documentation
| ost::TTYSession::TTYSession | ( | const char * | name, |
| int | pri = 0, |
||
| int | stack = 0 |
||
| ) |
Create TTY stream that will be managed by it's own thread.
- Parameters
-
name of tty device to open. pri execution priority. stack allocation needed on some platforms.
The documentation for this class was generated from the following file:
- commoncpp/serial.h
