stx::PipeSource Class Reference

Abstract class used as an input stream source for an ExecPipe. More...

#include <stx-execpipe.h>

List of all members.

Public Member Functions

 PipeSource ()
 Constructor which clears m_impl.
virtual bool poll ()=0
 Poll the input source for new data.
void write (const void *data, unsigned int datalen)
 Write input data to the first stage via a buffer.

Private Attributes

class ExecPipeImplm_impl
 pointer to associated pipe. filled by ExecPipe::add_input_source()

Friends

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

Detailed Description

Abstract class used as an input stream source for an ExecPipe.

Derived classes can be used in an ExecPipe to generate an input stream source. Data generated by this class is written to the first stage of the pipe.

When data is needed by the pipe the function poll() is called. This pure virtual function must generate data and push it into a buffer using the write() function. The input stream is terminated when poll() returns false.

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


Constructor & Destructor Documentation

stx::PipeSource::PipeSource (  ) 

Constructor which clears m_impl.

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


Member Function Documentation

virtual bool stx::PipeSource::poll (  )  [pure virtual]

Poll the input source for new data.

The input stream is closed when this function returns false, otherwise it will be polled again.

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

Write input data to the first stage via a buffer.

Definition at line 1673 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 50 of file stx-execpipe.h.


Member Data Documentation

pointer to associated pipe. filled by ExecPipe::add_input_source()

Definition at line 47 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