Yate
Public Member Functions | Static Public Member Functions
XMPPFeature Class Reference

A feature. More...

#include <xmpputils.h>

Inheritance diagram for XMPPFeature:
String GenObject XMPPFeatureCompress XMPPFeatureSasl

List of all members.

Public Member Functions

 XMPPFeature (int xml, int feature, bool required=false)
 XMPPFeature (int xml, const char *feature, bool required=false)
 XMPPFeature (int feature)
 XMPPFeature (const char *feature)
virtual ~XMPPFeature ()
bool required () const
virtual XmlElementbuild (bool addReq=true)
virtual XmlElementbuildFeature ()
void addReqChild (XmlElement &xml)

Static Public Member Functions

static XMPPFeaturefromStreamFeature (XmlElement &xml)

Detailed Description

A feature.

This class holds an XMPP feature


Constructor & Destructor Documentation

XMPPFeature ( int  xml,
int  feature,
bool  required = false 
) [inline]

Constructor

Parameters:
xmlXML element tag as enumeration
featureThe feature (namespace) index
requiredTrue if this feature is required
XMPPFeature ( int  xml,
const char *  feature,
bool  required = false 
) [inline]

Constructor

Parameters:
xmlXML element tag as enumeration
featureThe feature name
requiredTrue if this feature is required
XMPPFeature ( int  feature) [inline]

Constructor. Build from feature index

Parameters:
featureThe feature
XMPPFeature ( const char *  feature) [inline]

Constructor. Build from feature name

Parameters:
featureThe feature
virtual ~XMPPFeature ( ) [inline, virtual]

Destructor


Member Function Documentation

void addReqChild ( XmlElement xml)

Add a required/optional child to an element

Parameters:
xmlDestination element
virtual XmlElement* build ( bool  addReq = true) [virtual]

Build an xml element from this feature

Parameters:
addReqTrue to add the required/optional child
Returns:
XmlElement pointer or 0

Reimplemented in XMPPFeatureCompress, and XMPPFeatureSasl.

virtual XmlElement* buildFeature ( ) [virtual]

Build a feature element from this one

Returns:
XmlElement pointer
static XMPPFeature* fromStreamFeature ( XmlElement xml) [static]

Build a feature from a stream:features child

Parameters:
xmlThe feature element to parse
Returns:
XMPPFeature pointer or 0 if unknown
bool required ( ) const [inline]

Check if this feature is a required one

Returns:
True if this feature is a required one

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