Driver::TPipe Namespace Reference

The 'TPipe' namespace provides a point-to-point full duplex 'pipe' used to pass text based commands between to two end points. More...

Detailed Description

The 'TPipe' namespace provides a point-to-point full duplex 'pipe' used to pass text based commands between to two end points.

Each command is encapsulated in a HDLC like frame (i.e. Start-of-Frame, End-of-Frame characters, etc.). The first token in the frame is a 'command verb'. The command verb and any additional frame data is application specific. The 'command verb' must start immediately after the SOF character (e.g. no leading whitespace)

The connection between the two end-point is done by using two Cpl::Io streams, one each for TX and RX. The physical media is defined by the concrete stream classes.

A Pipe can have many 'transmit' and 'receive' clients.

Transmitting frames is guaranteed to be an atomic operation, i.e. if a frame is being transmitted, a requested to transmit a new frame will be blocked until the transmission of the current frame has completed.

Incoming frames are processed by Clients registering frame handlers that identify the individual frames/command they process. The frame handlers execute in the Pipe's thread. Each frame handler is responsible for providing thread-safe with respect to the application.

Classes
class	Maker
	This concrete class is a "Maker" that assembles the objects needed for TPipe. More...
class	Pipe
	This concrete class provides the implementation of TPipe. More...
class	RxFrameHandler
	This partially concrete class provides functionality that is common to all Frame handlers. More...
class	RxFrameHandlerApi
	This abstract class defines the 'Received Frame Handler' interface for the TPipe. More...
class	Tx
	This abstract class defines the 'Transmit Command' interface for the TPipe. More...