class SerialService

Thread pool service for serial ports. More...

Full nameost::SerialService
Definition#include <serial.h>
Inheritsost::Mutex [private ], ost::Thread [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Protected Methods


Detailed Description

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.

void  OnUpdate (unsigned char flag)

OnUpdate

[protected virtual]

A virtual handler for processing user defined update requests (1-254) which have been posted through Update.

Parameters:
flagof update request.

void  OnEvent (void)

OnEvent

[protected virtual]

A virtual handler for event loop calls. This can be used to extend event loop processing.

void  OnCallback (SerialPort *port)

OnCallback

[protected virtual]

A virtual handler for adding support for additional callback events into SerialPort.

Parameters:
serialport currently being evaluated.

void  Update (unsigned char flag = 0xff)

Update

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.

Parameters:
flagevent for OnUpdate, termination, or reschedule.

 SerialService (int pri = 0)

SerialService

Create a service thread for attaching serial ports. The thread begins execution with the first attached port.

Parameters:
priof this thread to run under.

 ~SerialService ()

~SerialService

[virtual]

Terminate the service thread and update attached objects.

inline int  getCount (void)

getCount

Get current reference count. This can be used when selecting the lead used service handler from a pool.

Returns: count of active ports.