ucommon
Public Member Functions | Protected Member Functions | Friends
ost::SerialPort Class Reference

The serial port is an internal class which is attached to and then serviced by a specified SerialService thread. More...

#include <serial.h>

Inheritance diagram for ost::SerialPort:
Inheritance graph
[legend]
Collaboration diagram for ost::SerialPort:
Collaboration graph
[legend]

Public Member Functions

void incTimer (timeout_t timeout)
 Derived incTimer to notify the service thread pool of a change in expected timeout.
void setTimer (timeout_t timeout=0)
 Derived setTimer to notify the service thread pool of changes in expected timeout.

Protected Member Functions

virtual void disconnect (void)
 Called by the service thread when an exception has occured such as a hangup.
virtual void expired (void)
 Called by the service thread when the objects timer has expired.
bool getDetectOutput (void) const
 Get the current state of the DetectOutput flag.
bool getDetectPending (void) const
 Get the current state of the DetectPending flag.
int input (void *buf, int len)
 Receive "input" for pending data from the serial port.
int output (void *buf, int len)
 Transmit "send" data to the serial port.
virtual void output (void)
 Perform when output is available for sending data.
virtual void pending (void)
 Called by the service thread when input data is pending for this tty port.
 SerialPort (SerialService *svc, const char *name)
 Construct a tty serial port for a named serial device.
void setDetectOutput (bool)
 Used to indicate if output ready monitoring should be performed by the service thread.
void setDetectPending (bool)
 Used to indicate if the service thread should monitor pending data for us.
virtual ~SerialPort ()
 Disconnect the Serial Port from the service pool thread and shutdown the port.

Friends

class SerialService

Detailed Description

The serial port is an internal class which is attached to and then serviced by a specified SerialService thread.

Derived versions of this class offer specific functionality such as serial integration protocols.

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.

Author:
David Sugar <dyfet@ostel.com> base class for thread pool serviced serial I/O.

Definition at line 621 of file serial.h.


Constructor & Destructor Documentation

ost::SerialPort::SerialPort ( SerialService svc,
const char *  name 
) [protected]

Construct a tty serial port for a named serial device.

Parameters:
svcpool thread object.
nameof tty port.

Member Function Documentation

Derived incTimer to notify the service thread pool of a change in expected timeout.

This allows SerialService to reschedule all timers.

Reimplemented from ost::TimerPort.

int ost::SerialPort::input ( void *  buf,
int  len 
) [inline, protected]

Receive "input" for pending data from the serial port.

This is not a public member since it's meant to support internal protocols rather than direct external access to the device.

Returns:
number of bytes received.
Parameters:
bufaddress of buffer to input.
lenof input buffer used.

Definition at line 719 of file serial.h.

int ost::SerialPort::output ( void *  buf,
int  len 
) [inline, protected]

Transmit "send" data to the serial port.

This is not public since it's meant to support internal protocols rather than direct public access to the device.

Returns:
number of bytes send.
Parameters:
bufaddress of buffer to send.
lenof bytes to send.

Definition at line 702 of file serial.h.

virtual void ost::SerialPort::pending ( void  ) [protected, virtual]

Called by the service thread when input data is pending for this tty port.

Effected by setPacketInput and by setLineInput.

void ost::SerialPort::setTimer ( timeout_t  timeout = 0)

Derived setTimer to notify the service thread pool of changes in expected timeout.

This allows SerialService to reschedule all timers.

Parameters:
timeoutin milliseconds.

Reimplemented from ost::TimerPort.


The documentation for this class was generated from the following file: