Main Page Class Hierarchy Alphabetical List Compound List File List Compound Members File Members Related Pages

LogStreamer Class Reference

#include <logstreamer.hpp>

Inheritance diagram for LogStreamer:

[legend]Collaboration diagram for LogStreamer:

[legend]List of all members.

Detailed Description

Named buffer reader XML handler class.

Definition at line 54 of file logstreamer.hpp.

Public Methods

LogStreamer (const XMLStreamerFactory *p_pParent, StreamerParams *p_pParameters, XMLFlowContext *p_pContext, XMLStreamConsumer *p_pOutput)

~LogStreamer ()

bool initStream ()

Stream beginning notifier.
This function is called before receiving any byte of the input XML stream. It should performs init tasks.

void writeData (const char *p_pszData, unsigned int p_uiDataLen)

XML Stream reception function.
This function is called to write input XML stream to the Streamer.

bool commitStream (bool p_fFinal=false)

xML Stream commit function.
This function is called to commit a chunk or the whole of the input XML stream.
A partial commit means that the data provided since last commit is OK for processing.
A final commit means that the whole input stream has been provided and that the streamer should consider the input XML document as complete.

Constructor & Destructor Documentation

BEGIN_XDFLENGINE_NS LogStreamer::LogStreamer ( const XMLStreamerFactory * p_pParent,

StreamerParams * p_pParameters,

XMLFlowContext * p_pContext,

XMLStreamConsumer * p_pOutput

)

Definition at line 54 of file logstreamer.cpp.

LogStreamer::~LogStreamer ( )

Definition at line 60 of file logstreamer.cpp.

Member Function Documentation

bool LogStreamer::commitStream ( bool p_fFinal = false ) [virtual]

xML Stream commit function.
This function is called to commit a chunk or the whole of the input XML stream.
A partial commit means that the data provided since last commit is OK for processing.
A final commit means that the whole input stream has been provided and that the streamer should consider the input XML document as complete.

Reimplemented from XMLStreamer.
Definition at line 89 of file logstreamer.cpp.
References XMLStreamConsumer::commitStream(), and XMLStreamer::m_pOutput.

bool LogStreamer::initStream ( ) [virtual]

Stream beginning notifier.
This function is called before receiving any byte of the input XML stream. It should performs init tasks.

Returns:
Not used, should return TRUE.

Reimplemented from XMLStreamer.
Definition at line 67 of file logstreamer.cpp.

void LogStreamer::writeData ( const char * p_pszData,

unsigned int p_uiDataLen

) [virtual]

XML Stream reception function.
This function is called to write input XML stream to the Streamer.

Parameters:

p_pszData XML stream chunk.

p_uiDataLen XML stream chunk length.

Reimplemented from XMLStreamer.
Definition at line 74 of file logstreamer.cpp.
References allocCharBuffer(), XMLStreamer::m_pOutput, releaseCharBuffer(), and XMLStreamConsumer::writeData().

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

Generated on Sat Oct 4 13:24:20 2003 for XDFLengine by

1.3-rc2


Public Methods
	LogStreamer (const XMLStreamerFactory p_pParent, StreamerParams p_pParameters, XMLFlowContext p_pContext, XMLStreamConsumer p_pOutput)
	~LogStreamer ()
bool	initStream ()
	Stream beginning notifier. This function is called before receiving any byte of the input XML stream. It should performs init tasks.
void	writeData (const char *p_pszData, unsigned int p_uiDataLen)
	XML Stream reception function. This function is called to write input XML stream to the Streamer.
bool	commitStream (bool p_fFinal=false)
	xML Stream commit function. This function is called to commit a chunk or the whole of the input XML stream. A partial commit means that the data provided since last commit is OK for processing. A final commit means that the whole input stream has been provided and that the streamer should consider the input XML document as complete.