XMPPFeatureList Class Reference

JID feature list. More...

#include <xmpputils.h>

Inheritance diagram for XMPPFeatureList:

Public Member Functions
bool	add (int xml, int feature, bool required=false)
bool	add (int feature)
bool	add (XMPPFeature *feature)
void	reset ()
void	add (XMPPFeatureList &list)
void	fromStreamFeatures (XmlElement &xml)
void	fromDiscoInfo (XmlElement &xml)
void	remove (int feature)
XMPPFeature *	get (int feature)
XMPPFeature *	get (const String &feature)
XMPPFeatureSasl *	getSasl ()
XMPPFeatureCompress *	getCompress ()
XmlElement *	buildStreamFeatures ()
XmlElement *	buildDiscoInfo (const char *from, const char *to, const char *id, const char *node=0, const char *cap=0)
void	add (XmlElement &xml)
void	updateEntityCaps ()
Public Member Functions inherited from ObjList
	ObjList ()
virtual	~ObjList ()
virtual void *	getObject (const String &name) const
unsigned int	length () const
unsigned int	count () const
GenObject *	get () const
GenObject *	set (const GenObject *obj, bool delold=true)
ObjList *	next () const
ObjList *	last () const
ObjList *	skipNull () const
ObjList *	skipNext () const
GenObject *	at (int index) const
ObjList *	operator+ (int index) const
GenObject *	operator[] (signed int index) const
GenObject *	operator[] (unsigned int index) const
GenObject *	operator[] (const String &str) const
ObjList *	find (const GenObject *obj) const
ObjList *	find (const String &str) const
int	index (const GenObject *obj) const
int	index (const String &str) const
ObjList *	insert (const GenObject *obj, bool compact=true)
ObjList *	append (const GenObject *obj, bool compact=true)
ObjList *	setUnique (const GenObject *obj, bool compact=true)
GenObject *	remove (bool delobj=true)
GenObject *	remove (GenObject *obj, bool delobj=true)
GenObject *	remove (const String &str, bool delobj=true)
void	clear ()
void	compact ()
bool	autoDelete ()
void	setDelete (bool autodelete)
void	sort (int(*callbackCompare)(GenObject *obj1, GenObject *obj2, void *context), void *context=0)
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	toString () const
virtual const String &	traceId () const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)

Public Attributes
JIDIdentityList	m_identities
String	m_entityCapsHash

Additional Inherited Members
Static Public Member Functions inherited from ObjList
static const ObjList &	empty ()
Static Public Member Functions inherited from GenObject
static void *	getObject (const String &name, const GenObject *obj)
static bool	getObjCounting ()
static void	setObjCounting (bool enable)
static NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()

Detailed Description

JID feature list.

This class holds a list of JID features

Member Function Documentation

add() [1/5]

bool add ( int feature )

inline

Add a feature to the list

Parameters

feature

The feature to add as enumeration

Returns

False if the given feature already exists

References ObjList::append(), and get().

add() [2/5]

bool add ( int xml, int feature, bool required = false )

inline

Add a feature to the list

Parameters

xml	XML element tag as enumeration
feature	The feature to add as enumeration
required	True if this feature is required

Returns

False if the given feature already exists

References ObjList::append(), and get().

add() [3/5]

void add

(

XmlElement &

xml

)

Add this list to an xml element

Parameters

xml	Destination element

add() [4/5]

bool add ( XMPPFeature * feature )

inline

Add a feature to the list. Destroy the received parameter if already in the list

Parameters

feature

The feature to add

Returns

False if the given feature already exists

References ObjList::append(), and get().

add() [5/5]

void add

(

XMPPFeatureList &

list

)

Move a list of features to this list. Don't check duplicates

Parameters

list	The source list

buildDiscoInfo()

XmlElement * buildDiscoInfo	(	const char *	from,
		const char *	to,
		const char *	id,
		const char *	node = 0,
		const char *	cap = 0 )

Build an iq query disco info result from this list

Parameters

from	The 'from' attribute
to	The 'to' attribute
id	The 'id' attribute
node	Optional 'node' attribute
cap	Optional capability to be set as 'node' suffix

Returns

XmlElement pointer

buildStreamFeatures()

XmlElement * buildStreamFeatures

(

)

Build stream features from this list

Returns

XmlElement pointer

fromDiscoInfo()

void fromDiscoInfo

(

XmlElement &

xml

)

Re-build this list from disco info responses

Parameters

xml	The element to parse

fromStreamFeatures()

void fromStreamFeatures

(

XmlElement &

xml

)

Re-build this list from stream features

Parameters

xml	The features element to parse

get() [1/2]

XMPPFeature * get ( const String & feature )

inline

Get a feature from the list

Parameters

feature

The feature name to find

Returns

Pointer to the feature or 0 if it doesn't exists

References ObjList::find(), ObjList::get(), and ObjList::ObjList().

get() [2/2]

XMPPFeature * get

(

int

feature

)

Get a feature from the list

Parameters

feature

The feature to get

Returns

Pointer to the feature or 0 if it doesn't exists

Referenced by add(), add(), add(), getCompress(), getSasl(), and remove().

getCompress()

XMPPFeatureCompress * getCompress ( )

inline

Get a XMPPFeatureCompress feature from list

Returns

XMPPFeatureCompress pointer or 0 if not found

References get().

getSasl()

XMPPFeatureSasl * getSasl ( )

inline

Get a XMPPFeatureSasl feature from list

Returns

XMPPFeatureSasl pointer or 0 if not found

References get().

remove()

void remove ( int feature )

inline

Remove a feature from the list

Parameters

feature

The feature to remove

References get(), and ObjList::remove().

reset()

void reset ( )

inline

Clear data

References ObjList::clear().

updateEntityCaps()

void updateEntityCaps

(

)

Update the entity capabilities hash

---

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

• xmpputils.h