Definitions of Terms

• Pipe, Pipe line: The code that processes a data stream using the AxPipe framework. It is built from at least 2 to an unlimited number of sections. All pipe lines generally begin with a AxPipe::CSource, and end with a AxPipe::CSink.

• Source: AxPipe::CSource's are intended to provide data for the pipe (stream), for example by reading from a file.

• Section: In between, there can be many processing steps based on AxPipe::CPipe and AxPipe::CFilter, and also some more elaborate constuctions such as multi-pipe AxPipe::CJoin:s and AxPipe::CSplit:s.

• Sink: AxPipe::CSink's are intended to store the data that is the result of the processing, for example into a file.

Data Movement

The native model for data movement is the push model. This means that data is read from the AxPipe::CSource, and then pushed down the pipe, i.e. the subsequent sections are called with each respective segment as they are read. This model is suited for simple processing with few or no input states.

The pull model is also supported in AxPipe::CFilter derived classes. In this model your code will request data by a member function call, which returns with requested data when available. This is suitable for more complex parsing where perhaps many possible input states exist.

Data Unit

The basic unit of data is a AxPipe::CSeg object, which is a reference counted memory buffer object of (size_t limited) arbitrary size. Code written for AxPipe should usually not depend on CSeg objects being of any particular size, except in derived classes where such guarantees are provided.

See also:

Introduction, Installation, A First Example, A Second Examle, Definitions of Terms, Stock Transformations, Utilities and Overrides

---