class XMLParser

An XML parser. More...

Full nameTelEngine::XMLParser
Definition#include <libs/yjingle/xmlparser.h>
InheritsTelEngine::Mutex [public ], TelEngine::TiXmlDocument [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Members


Detailed Description

This class is responsable of parsing incoming data. Keeps the resulting XML elements and the input buffer

inline  XMLParser ()

XMLParser

Constructor. Constructs an XML parser

 ~XMLParser ()

~XMLParser

[virtual]

Destructor

bool  consume (const char* data, u_int32_t len)

consume

Add data to buffer. Parse the buffer. On success, the already parsed data is removed from buffer. This method is thread safe

Parameters:
dataPointer to the data to consume
lenData length

Returns: True on successfully parsed

XMLElement*  extract ()

extract

Extract the first XML element from document. Remove non-element children of the document (e.g. declaration). This method is thread safe

Returns: Pointer to an XMLElement or 0 if the document is empty

inline unsigned int  bufLen ()

bufLen

[const]

Get the buffer length (incomplete data)

Returns: The number of bytes belonging to an incomplete XML element

inline void  getBuffer (String& dest)

getBuffer

[const]

Get a copy of the parser's buffer

Parameters:
destDestination string

void  reset ()

reset

Clear the parser's input buffer and already parsed elements. Reset data

static u_int32_t s_maxDataBuffer

s_maxDataBuffer

static TiXmlEncoding s_xmlEncoding

s_xmlEncoding


Generated by: paulc on bussard on Mon Mar 8 12:18:15 2010, using kdoc 2.0a54.