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

FSGetStreamer Class Reference

#include <fsgetstreamer.hpp>

Inheritance diagram for FSGetStreamer:

[legend]Collaboration diagram for FSGetStreamer:

[legend]List of all members.

Detailed Description

Named buffer reader XML handler class.

Definition at line 54 of file fsgetstreamer.hpp.

Public Methods

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

~FSGetStreamer ()

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 FSGetStreamer::FSGetStreamer ( const XMLStreamerFactory * p_pParent,

StreamerParams * p_pParameters,

XMLFlowContext * p_pContext,

XMLStreamConsumer * p_pOutput

)

Definition at line 56 of file fsgetstreamer.cpp.
References DEBUG_CREATE.

FSGetStreamer::~FSGetStreamer ( )

Definition at line 65 of file fsgetstreamer.cpp.
References DEBUG_DEL.

Member Function Documentation

bool FSGetStreamer::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 92 of file fsgetstreamer.cpp.
References CATCH_XML_FLOW_ERROR_RELEASE_AND_RETURN, DEBUG_IN, DEBUG_OUT, XMLStreamer::getParamValue(), MAKE_XMLFLOW_EXCEPTION, ON_XML_FLOW_ERROR_THROW, PREP_CATCH_XML_FLOW_ERROR, and WATCH_XML_FLOW_ERROR.

bool FSGetStreamer::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 75 of file fsgetstreamer.cpp.
References DEBUG_FUNC.

void FSGetStreamer::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 84 of file fsgetstreamer.cpp.
References DEBUG_FUNC.

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

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

1.3-rc2


Public Methods
	FSGetStreamer (const XMLStreamerFactory p_pParent, StreamerParams p_pParameters, XMLFlowContext p_pContext, XMLStreamConsumer p_pOutput)
	~FSGetStreamer ()
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.