UCommon
|
The SerialService is a thead service object that is meant to service attached serial ports. More...
#include <serial.h>
Inherits ost::Thread, and ost::Mutex.
Public Member Functions | |
int | getCount (void) const |
Get current reference count. More... | |
SerialService (int pri=0, size_t stack=0, const char *id=NULL) | |
Create a service thread for attaching serial ports. More... | |
void | update (uint8_t flag=0xff) |
Notify service thread that a port has been added or removed, or a timer changed, so that a new schedule can be computed for expiring attached ports. More... | |
virtual | ~SerialService () |
Terminate the service thread and update attached objects. | |
Protected Member Functions | |
virtual void | onCallback (SerialPort *port) |
A virtual handler for adding support for additional callback events into SerialPort. More... | |
virtual void | onEvent (void) |
A virtual handler for event loop calls. More... | |
virtual void | onUpdate (uint8_t flag) |
A virtual handler for processing user defined update requests (1-254) which have been posted through Update. More... | |
Friends | |
class | SerialPort |
The SerialService is a thead service object that is meant to service attached serial ports.
Multiple pool objects may be created and multiple serial ports may be attached to the same thread of of execution. This allows one to balance threads and the serial ports they service.
The TTYPort and TTYService classes are used to form thread-pool serviced serial I/O protocol sets. These can be used when one has a large number of serial devices to manage, and a single (or limited number of) thread(s) can then be used to service the tty port objects present. Each tty port supports a timer control and several virtual methods that the service thread can call when events occur. This model provides for "callback" event management, whereby the service thread performs a "callback" into the port object when events occur. Specific events supported include the expiration of a TTYPort timer, pending input data waiting to be read, and "sighup" connection breaks.
ost::SerialService::SerialService | ( | int | pri = 0 , |
size_t | stack = 0 , |
||
const char * | id = NULL |
||
) |
Create a service thread for attaching serial ports.
The thread begins execution with the first attached port.
pri | of this thread to run under. |
stack | stack size. |
id | stack ID. |
|
inline |
|
protectedvirtual |
A virtual handler for adding support for additional callback events into SerialPort.
port | serial port currently being evaluated. |
|
protectedvirtual |
A virtual handler for event loop calls.
This can be used to extend event loop processing.
|
protectedvirtual |
A virtual handler for processing user defined update requests (1-254) which have been posted through Update.
flag | of update request. |
void ost::SerialService::update | ( | uint8_t | flag = 0xff | ) |
Notify service thread that a port has been added or removed, or a timer changed, so that a new schedule can be computed for expiring attached ports.
This can also be used to pass requests to the OnUpdate() event handler.
flag | event for OnUpdate, termination, or reschedule. |