---

XMLStreamerFactory Class Reference

#include <xmlstreamerfactory.hpp>

Inheritance diagram for XMLStreamerFactory:

[legend]Collaboration diagram for XMLStreamerFactory:

[legend]List of all members.

---

Detailed Description

This class defines a XMLStreamer producer object.
XMLStreamerFactory objects are created and maintained by the XMLProcessor. They are invoked to produce XMLStreamers for each active node in the XDFL scripts.
This class should also be used to maintain a state which is specific to the kind of XMlStreamers produced and which is maintained for the XMLProcessor lifetime.

Definition at line 63 of file xmlstreamerfactory.hpp.

Public Methods
	XMLStreamerFactory ()
	Constructor.
virtual	~XMLStreamerFactory ()
	Destructor.
void	setParent (XMLProcessor *p_pParentProcessor)
	Sets parent XMLprocessor object.
XMLProcessor *	getParent () const
	Returns parent XMLProcessor object.
virtual XMLStreamer *	getStreamer (StreamerParams *p_pParameters, XMLFlowContext *p_pStreamContext, XMLStreamConsumer *p_pStreamConsumer) const=0
	This function produces and returns the streamer objects.
virtual void	tick (unsigned long p_ulClock)
	Time ticker method. This method is to be called periodically by a separate thread for the handler to make its state maintenance tasks.
Protected Attributes
XMLProcessor *	m_pParentProcessor
	Parent XMLprocessor object.

---

Constructor & Destructor Documentation

BEGIN_XDFLENGINE_NS XMLStreamerFactory::XMLStreamerFactory (    )

Constructor. Definition at line 51 of file xmlstreamerfactory.cpp. References m_pParentProcessor.

XMLStreamerFactory::~XMLStreamerFactory (    )  [virtual]

Destructor. Definition at line 59 of file xmlstreamerfactory.cpp.

---

Member Function Documentation

XMLProcessor * XMLStreamerFactory::getParent (    )  const

Returns parent XMLProcessor object. Returns: Parent XMLProcessor object. Definition at line 76 of file xmlstreamerfactory.cpp. References DEBUG_FUNC, and m_pParentProcessor.

virtual XMLStreamer* XMLStreamerFactory::getStreamer (  StreamerParams *    p_pParameters, XMLFlowContext *    p_pStreamContext, XMLStreamConsumer *    p_pStreamConsumer )  const [pure virtual]

This function produces and returns the streamer objects. Parameters: p_pParameters  Streamers parameters, as a collection of name/value string pairs. p_pStreamContext  Stream context object. p_pStreamConsumer  The object in which the produced XML is written. Implemented in AutodescStreamerFactory, CacheDefinitionStreamerFactory, DDLStreamerFactory, DBOBJGetStreamerFactory, DBOBJSetStreamerFactory, SQLStreamerFactory, FSGetStreamerFactory, FSSetStreamerFactory, UnzipStreamerFactory, ZipStreamerFactory, CacheScriptStreamerFactory, ExecStreamerFactory, FuncCallStreamerFactory, FuncDefineStreamerFactory, IFStreamerFactory, LogStreamerFactory, NamedBufferGetStreamerFactory, NamedBufferSetStreamerFactory, _NamedBufferSetStreamerFactory, NullStreamerFactory, RaiseErrorStreamerFactory, RawStreamerFactory, SystemStreamerFactory, ValuesStreamerFactory, _ValuesStreamerFactory, LangLoadStreamerFactory, and LangSetStreamerFactory. Referenced by ActiveStreamNode::streamXML().

void XMLStreamerFactory::setParent (  XMLProcessor *    p_pParentProcessor )

Sets parent XMLprocessor object. Parameters: p_pParentProcessor  Parent XMLprocessor object. Definition at line 66 of file xmlstreamerfactory.cpp. References DEBUG_FUNC, and m_pParentProcessor. Referenced by XMLProcessor::addStreamerFactory().

void XMLStreamerFactory::tick (  unsigned long    p_ulClock )  [virtual]

Time ticker method. This method is to be called periodically by a separate thread for the handler to make its state maintenance tasks. Parameters: p_ulClock  current time, in tick counts. Reimplemented in DBStreamerFactory. Definition at line 86 of file xmlstreamerfactory.cpp. Referenced by XMLProcessor::tick().

---

Member Data Documentation

XMLProcessor* XMLStreamerFactory::m_pParentProcessor [protected]

Parent XMLprocessor object. Definition at line 68 of file xmlstreamerfactory.hpp. Referenced by getParent(), setParent(), and XMLStreamerFactory().

---

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

• xmlstreamerfactory.hpp
• xmlstreamerfactory.cpp

---