Plugin Class Reference

#include <plugin.h>

Inheritance diagram for Plugin:

Public Member Functions
	Plugin (SM &sm, TagHandler &router)
virtual	~Plugin ()
virtual bool	handleTag (const gloox::Tag *tag)=0
virtual const std::string &	filterString () const =0

Detailed Description

Abstract base class for a (sub)protocol such as Roster Management, Private XML Storage, etc.

Author

Jakob Schroeter js@ca.nosp@m.maya.nosp@m..net

Since

0.2

Definition at line 39 of file plugin.h.

Constructor & Destructor Documentation

Plugin ( SM &  sm, TagHandler &  router  )

inline

Constructor.

Parameters

sm	The SM to use.
router	The Router to use.

Definition at line 47 of file plugin.h.

virtual ~Plugin ( )

inlinevirtual

Virtual destructor.

Definition at line 54 of file plugin.h.

Member Function Documentation

virtual const std::string& filterString ( ) const

pure virtual

Returns an XPath expression that matches the Plugin's supported stanzas.

Returns

An XPath expression.

Implemented in RosterManager, MessageManager, PresenceManager, DiscoManager, and VCardManager.

virtual bool handleTag ( const gloox::Tag *  tag )

pure virtual

Reimplement this function to handle incoming tags matched by the XPath expression returned by filterString().

Parameters

tag	A Tag to handle.

Returns

True if the Tag has been handled, false if it is to be passed on to the next Plugin in the chain.

Implemented in RosterManager, MessageManager, PresenceManager, DiscoManager, and VCardManager.

---

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

• plugin.h