XMPP::Stanza Class Reference

XMPP stanzas: the following classes represent the three stanzas (PDUs) defined by the xmpp protocol. More...

#include <xmpp.h>

Inheritance diagram for XMPP::Stanza:

Collaboration diagram for XMPP::Stanza:

Public Member Functions
virtual PBoolean	IsValid () const =0
virtual PString	GetID () const
virtual PString	GetFrom () const
virtual PString	GetTo () const
virtual void	SetID (const PString &id)
virtual void	SetFrom (const PString &from)
virtual void	SetTo (const PString &to)
virtual PXMLElement *	GetElement (const PString &name, PINDEX i=0)
Public Member Functions inherited from PXML
	PXML (Options options=NoOptions, const char *noIndentElements=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)
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, 7,(NoOptions, Indent, IndentWithTabs, NewLineAfterElement, NoIgnoreWhiteSpace, CloseExtended, WithNS, FragmentOnly), AllOptions=(1<<(6+1))-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
unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...
void	SetTraceContextIdentifier (unsigned id)
void	GetTraceContextIdentifier (PObject &obj)
void	GetTraceContextIdentifier (PObject *obj)
void	SetTraceContextIdentifier (const PObject &obj)
void	SetTraceContextIdentifier (const PObject *obj)
virtual	~PObject ()
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 const char *	GetClass (unsigned ancestor=0) const
	Get the current dynamic type of the object instance. More...
PBoolean	IsClass (const char *cls) const
virtual PBoolean	InternalIsDescendant (const char *clsName) const
	Determine if the dynamic type of the current instance is a descendent of the specified class. More...
__inline const PObject *	PTraceObjectInstance () const
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...

Static Public Member Functions
static const PCaselessString &	IDTag ()
	Various constant strings. More...
static const PCaselessString &	FromTag ()
static const PCaselessString &	ToTag ()
static PString	GenerateID ()
Static Public Member Functions inherited from PXML
static PString	EscapeSpecialChars (const PString &string)

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 }
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...
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
Friends inherited from PObject

Detailed Description

XMPP stanzas: the following classes represent the three stanzas (PDUs) defined by the xmpp protocol.

Member Function Documentation

static const PCaselessString& XMPP::Stanza::FromTag ( )

static

static PString XMPP::Stanza::GenerateID ( )

static

virtual PXMLElement* XMPP::Stanza::GetElement ( const PString &  name, PINDEX  i = 0  )

virtual

virtual PString XMPP::Stanza::GetFrom ( ) const

virtual

virtual PString XMPP::Stanza::GetID ( ) const

virtual

virtual PString XMPP::Stanza::GetTo ( ) const

virtual

static const PCaselessString& XMPP::Stanza::IDTag ( )

static

Various constant strings.

virtual PBoolean XMPP::Stanza::IsValid ( ) const

pure virtual

Implemented in XMPP::IQ, XMPP::Presence, and XMPP::Message.

virtual void XMPP::Stanza::SetFrom ( const PString &  from )

virtual

virtual void XMPP::Stanza::SetID ( const PString &  id )

virtual

virtual void XMPP::Stanza::SetTo ( const PString &  to )

virtual

static const PCaselessString& XMPP::Stanza::ToTag ( )

static

---

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

• xmpp.h