XMPP::JID Class Reference

#include <xmpp.h>

Inheritance diagram for XMPP::JID:

Collaboration diagram for XMPP::JID:

Public Member Functions
	JID (const char *jid=0)
	JID (const PString &jid)
	JID (const PString &user, const PString &server, const PString &resource=PString::Empty())
virtual Comparison	Compare (const PObject &obj) const
	Compare the two objects and return their relative rank. More...
JID &	operator= (const PString &jid)
	operator const PString & () const
virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...
PString	GetUser () const
PString	GetServer () const
virtual PString	GetResource () const
virtual void	SetUser (const PString &user)
virtual void	SetServer (const PString &server)
virtual void	SetResource (const PString &resource)
virtual PBoolean	IsBare () const
virtual void	PrintOn (ostream &strm) const
	Output the contents of the object to the stream. More...
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 ()
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	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...
virtual void	ReadFrom (istream &strm)
	Input the contents of the object from the stream. More...

Protected Member Functions
virtual void	ParseJID (const PString &jid)
virtual void	BuildJID () const
Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes
PString	m_User
PString	m_Server
PString	m_Resource
PString	m_JID
PBoolean	m_IsDirty
Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

Additional Inherited Members
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 PObject
static const char *	Class ()
	Get the name of the class as a C string. More...
static __inline const PObject *	PTraceObjectInstance (const char *)
static __inline const PObject *	PTraceObjectInstance (const PObject *obj)
static Comparison	InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...
Friends inherited from PObject

Constructor & Destructor Documentation

XMPP::JID::JID

(

const char *

jid = 0

)

Referenced by Clone().

XMPP::JID::JID

(

const PString &

jid

)

XMPP::JID::JID	(	const PString &	user,
		const PString &	server,
		const PString &	resource = PString::Empty()
	)

Member Function Documentation

virtual void XMPP::JID::BuildJID ( ) const

protectedvirtual

virtual PObject* XMPP::JID::Clone ( ) const

inlinevirtual

Create a copy of the class on the heap.

The exact semantics of the descendent class determine what is required to make a duplicate of the instance. Not all classes can even do a clone operation.

The main user of the clone function is the PDictionary class as it requires copies of the dictionary keys.

The default behaviour is for this function to assert.

Returns

pointer to new copy of the class instance.

Reimplemented from PObject.

Reimplemented in XMPP::BareJID.

References JID(), and m_JID.

virtual Comparison XMPP::JID::Compare ( const PObject &  obj ) const

virtual

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns

LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Parameters

obj	Object to compare against.

Reimplemented from PObject.

Reimplemented in XMPP::BareJID.

virtual PString XMPP::JID::GetResource ( ) const

inlinevirtual

Reimplemented in XMPP::BareJID.

References m_Resource.

PString XMPP::JID::GetServer ( ) const

inline

References m_Server.

PString XMPP::JID::GetUser ( ) const

inline

References m_User.

virtual PBoolean XMPP::JID::IsBare ( ) const

inlinevirtual

Reimplemented in XMPP::BareJID.

References PString::IsEmpty(), and m_Resource.

XMPP::JID::operator const PString &

(

)

const

JID& XMPP::JID::operator=

(

const PString &

jid

)

Parameters

jid	New JID to assign.

virtual void XMPP::JID::ParseJID ( const PString &  jid )

protectedvirtual

virtual void XMPP::JID::PrintOn ( ostream &  strm ) const

virtual

Output the contents of the object to the stream.

The exact output is dependent on the exact semantics of the descendent class. This is primarily used by the standard operator<< function.

The default behaviour is to print the class name.

Reimplemented from PObject.

virtual void XMPP::JID::SetResource ( const PString &  resource )

virtual

Reimplemented in XMPP::BareJID.

virtual void XMPP::JID::SetServer ( const PString &  server )

virtual

virtual void XMPP::JID::SetUser ( const PString &  user )

virtual

Member Data Documentation

PBoolean XMPP::JID::m_IsDirty

mutableprotected

PString XMPP::JID::m_JID

mutableprotected

Referenced by Clone(), and XMPP::BareJID::Clone().

PString XMPP::JID::m_Resource

protected

Referenced by GetResource(), and IsBare().

PString XMPP::JID::m_Server

protected

Referenced by GetServer().

PString XMPP::JID::m_User

protected

Referenced by GetUser().

---

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

• xmpp.h