#include <pxml.h>

Inheritance diagram for PXML_HTTP:

Collaboration diagram for PXML_HTTP:

Public Member Functions
	PXML_HTTP (Options options=NoOptions, const char *noIndentElements=NULL)

bool	StartAutoReloadURL (const PURL &url, const PTimeInterval &timeout, const PTimeInterval &refreshTime, Options options=NoOptions)

bool	StopAutoReloadURL ()

PString	GetAutoReloadStatus () const

bool	AutoLoadURL ()

virtual void	OnAutoLoad (PBoolean ok)

bool	LoadURL (const PURL &url)

bool	LoadURL (const PURL &url, const PTimeInterval &timeout, Options options=NoOptions)

bool	LoadURL (const PURL &url, const PURL::LoadParams &params, Options options=NoOptions)

Public Member Functions inherited from PXML
	PXML (Options options=NoOptions, const char noIndentElements=NULL, const char defaultEncoding=NULL)

	PXML (const PXML &xml)

	~PXML ()

void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...

PString	AsString () const

bool	IsDirty () const

bool	Load (const PString &data)

bool	Load (const PString &data, Options options, const char *defaultEncoding=NULL)

bool	LoadFile (const PFilePath &fn)

bool	LoadFile (const PFilePath &fn, Options options)

virtual bool	OnLoadProgress (unsigned) const

virtual void	OnLoaded ()

bool	Save ()

bool	Save (Options options)

PString	AsString ()

PString	AsString (Options options)

bool	SaveFile (const PFilePath &fn)

bool	SaveFile (const PFilePath &fn, Options options)

virtual bool	OnSaveProgress (unsigned) const

virtual bool	OutputProgress () const

virtual PINDEX	GetObjectCount () const

void	RemoveAll ()

virtual PBoolean	IsNoIndentElement (const PString &elementName) const

virtual PXMLElement *	CreateElement (const PCaselessString &name, const char *data=NULL)

virtual PXMLRootElement *	CreateRootElement (const PCaselessString &name)

PXMLElement *	GetElement (const PCaselessString &name, const PCaselessString &attr, const PString &attrval) const

PXMLElement *	GetElement (const PCaselessString &name, PINDEX idx=0) const

PXMLElement *	GetElement (PINDEX idx) const

PINDEX	GetNumElements () const

PXMLElement *	SetRootElement (PXMLRootElement *root)

PXMLElement *	SetRootElement (const PString &documentType)

bool	Validate (const ValidationInfo *validator)

bool	ValidateElements (ValidationContext &context, PXMLElement baseElement, const ValidationInfo elements)

bool	ValidateElement (ValidationContext &context, PXMLElement element, const ValidationInfo elements)

bool	LoadAndValidate (const PString &body, const PXML::ValidationInfo *validator, PString &error, Options options=NoOptions)

const PCaselessString &	GetVersion () const

const PCaselessString &	GetEncoding () const

StandAloneType	GetStandAlone () const

bool	IsLoaded () const

PXMLRootElement *	GetRootElement () const

PCaselessString	GetDocumentType () const

const PCaselessString &	GetDocType () const

const PCaselessString &	GetPubicIdentifier () const

const PCaselessString &	GetDtdURI () const

PString	GetErrorString () const

unsigned	GetErrorColumn () const

unsigned	GetErrorLine () const

Public Member Functions inherited from PXMLBase
	P_DECLARE_BITWISE_ENUM_EX (Options, 8,(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly, ExpandEntities), AllOptions=(1<< 8)-1)

	PXMLBase (Options opts=NoOptions)

void	SetOptions (Options opts)

Options	GetOptions () const

void	SetMaxEntityLength (unsigned len)

unsigned	GetMaxEntityLength () const

bool	OutputIndent (ostream &strm, int indent, const PString &elementName=PString::Empty()) const

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

virtual PINDEX	HashFunction () const
	This function yields a hash value required by the `PDictionary` class. More...

virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...

virtual Comparison	CompareObjectMemoryDirect (const PObject &obj) const
	Determine the byte wise comparison of two objects. More...

bool	operator== (const PObject &obj) const
	Compare the two objects. More...

bool	operator!= (const PObject &obj) const
	Compare the two objects. More...

bool	operator< (const PObject &obj) const
	Compare the two objects. More...

bool	operator> (const PObject &obj) const
	Compare the two objects. More...

bool	operator<= (const PObject &obj) const
	Compare the two objects. More...

bool	operator>= (const PObject &obj) const
	Compare the two objects. More...

Protected Member Functions
	PDECLARE_NOTIFIER (PTimer, PXML_HTTP, AutoReloadTimeout)

	PDECLARE_NOTIFIER (PThread, PXML_HTTP, AutoReloadThread)

	PDECLARE_MUTEX (m_autoLoadMutex)

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PTimer	m_autoLoadTimer

PURL	m_autoloadURL

PTimeInterval	m_autoLoadWaitTime

PString	m_autoLoadError

Protected Attributes inherited from PXML
PFilePath	m_loadFilename

PCaselessString	m_version

PCaselessString	m_encoding

StandAloneType	m_standAlone

PCaselessString	m_docType

PCaselessString	m_publicId

PCaselessString	m_dtdURI

PXMLRootElement *	m_rootElement

PStringStream	m_errorString

unsigned	m_errorLine

unsigned	m_errorColumn

PSortedStringList	m_noIndentElements

PCaselessString	m_defaultNameSpace

PINDEX	m_totalObjects

PINDEX	m_savedObjects

unsigned	m_percent

Protected Attributes inherited from PXMLBase
Options	m_options

unsigned	m_maxEntityLength

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
Public Types inherited from PXML
enum	ValidationOp { EndOfValidationList, DocType, ElementName, RequiredAttribute, RequiredNonEmptyAttribute, RequiredAttributeWithValue, RequiredElement, Subtree, RequiredAttributeWithValueMatching, RequiredElementWithBodyMatching, OptionalElement, OptionalAttribute, OptionalNonEmptyAttribute, OptionalAttributeWithValue, OptionalAttributeWithValueMatching, OptionalElementWithBodyMatching, SetDefaultNamespace, SetNamespace, RequiredAttributeWithValueMatchingEx = RequiredAttributeWithValueMatching + 0x8000, OptionalAttributeWithValueMatchingEx = OptionalAttributeWithValueMatching + 0x8000, RequiredElementWithBodyMatchingEx = RequiredElementWithBodyMatching + 0x8000, OptionalElementWithBodyMatchingEx = OptionalElementWithBodyMatching + 0x8000 }

Public Types inherited from PXMLBase
enum	{ DEFAULT_MAX_ENTITY_LENGTH = 65536 }

enum	StandAloneType { UninitialisedStandAlone = -2, UnknownStandAlone = -1, NotStandAlone, IsStandAlone }

Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PXML
static PString	EscapeSpecialChars (const PString &string)

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Constructor & Destructor Documentation

PXML_HTTP::PXML_HTTP	(	Options	options = `NoOptions`,
		const char *	noIndentElements = `NULL`
	)

Member Function Documentation

bool PXML_HTTP::AutoLoadURL ( )

PString PXML_HTTP::GetAutoReloadStatus ( ) const

bool PXML_HTTP::LoadURL ( const PURL & url )

bool PXML_HTTP::LoadURL	(	const PURL &	url,
		const PTimeInterval &	timeout,
		Options	options = `NoOptions`
	)

bool PXML_HTTP::LoadURL	(	const PURL &	url,
		const PURL::LoadParams &	params,
		Options	options = `NoOptions`
	)

virtual void PXML_HTTP::OnAutoLoad ( PBoolean ok )

virtual

PXML_HTTP::PDECLARE_MUTEX ( m_autoLoadMutex )

protected

PXML_HTTP::PDECLARE_NOTIFIER	(	PTimer	,
		PXML_HTTP	,
		AutoReloadTimeout
	)

protected

PXML_HTTP::PDECLARE_NOTIFIER	(	PThread	,
		PXML_HTTP	,
		AutoReloadThread
	)

protected

bool PXML_HTTP::StartAutoReloadURL	(	const PURL &	url,
		const PTimeInterval &	timeout,
		const PTimeInterval &	refreshTime,
		Options	options = `NoOptions`
	)

bool PXML_HTTP::StopAutoReloadURL ( )

Member Data Documentation

PString PXML_HTTP::m_autoLoadError

protected

PTimer PXML_HTTP::m_autoLoadTimer

protected

PURL PXML_HTTP::m_autoloadURL

protected

PTimeInterval PXML_HTTP::m_autoLoadWaitTime

protected

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

pxml.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation