stx::PipeFunction Class Reference

Abstract class used as an intermediate pipe stage between executed processes. More...

#include <stx-execpipe.h>

Inheritance diagram for stx::PipeFunction:
stx::PipeSink

List of all members.

Public Member Functions

 PipeFunction ()
 Constructor which clears m_impl and m_stageid.
void write (const void *data, unsigned int datalen)
 Write input data to the next pipe stage via a buffer.

Private Attributes

class ExecPipeImplm_impl
 pointer to associated pipe filled by ExecPipe::add_function()
unsigned int m_stageid
 pipe stage identifier

Friends

class ExecPipeImpl
 association to the pipe implementation for write access to m_impl.

Detailed Description

Abstract class used as an intermediate pipe stage between executed processes.

Derived classes can be inserted into an execution pipe between two externally executed processes. It will receive all data from the preceding pipe stage and after processing it may forward output to the next pipe stage.

The class is derived from PipeSink and receives data from the preceding stage via the inherited functions process() and also the eof() signal. Usually process() will perform some action on the data and then forward the resulting data block to the next pipe stage via write().

Definition at line 100 of file stx-execpipe.h.


Constructor & Destructor Documentation

stx::PipeFunction::PipeFunction (  ) 

Constructor which clears m_impl and m_stageid.

Definition at line 1681 of file stx-execpipe.cc.


Member Function Documentation

void stx::PipeFunction::write ( const void *  data,
unsigned int  datalen 
)

Write input data to the next pipe stage via a buffer.

Definition at line 1686 of file stx-execpipe.cc.


Friends And Related Function Documentation

friend class ExecPipeImpl [friend]

association to the pipe implementation for write access to m_impl.

Definition at line 110 of file stx-execpipe.h.


Member Data Documentation

pointer to associated pipe filled by ExecPipe::add_function()

Definition at line 104 of file stx-execpipe.h.

unsigned int stx::PipeFunction::m_stageid [private]

pipe stage identifier

Definition at line 107 of file stx-execpipe.h.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends
Generated on Sun Jul 18 22:23:45 2010 for STX Execution Pipe by  doxygen 1.6.3