Event Class Reference

This is an implementation of a PubSub Notification StanzaExtension. More...

#include <pubsubevent.h>

Inherits StanzaExtension.

Inheritance diagram for Event:

[legend]List of all members.

Public Types
typedef std::list< ItemOperation * >	ItemOperationList
Public Member Functions
	Event (const Tag *event)
virtual	~Event ()
PubSub::EventType	type () const
const StringList &	subscriptions () const
const ItemOperationList &	items () const
const std::string &	node ()
const std::string &	filterString () const
StanzaExtension *	newInstance (const Tag *tag) const
Tag *	tag () const
Classes
struct	ItemOperation

---

Detailed Description

This is an implementation of a PubSub Notification StanzaExtension.

Author:

Vincent Thomasset <vthomasset@gmail.com>

Since:

1.0

Definition at line 34 of file pubsubevent.h.

---

Member Typedef Documentation

typedef std::list<ItemOperation*> ItemOperationList

A list of ItemOperations. Definition at line 62 of file pubsubevent.h.

---

Constructor & Destructor Documentation

Event (  const Tag *  event  )

PubSub event notification Stanza Extension. Parameters: event  A tag to parse. Definition at line 32 of file pubsubevent.cpp.

~Event (   )  [virtual]

Virtual destructor. Definition at line 122 of file pubsubevent.cpp.

---

Member Function Documentation

const std::string & filterString (   )  const [virtual]

Returns an XPath expression that describes a path to child elements of a stanza that an extension handles. Returns: The extension's filter string. Implements StanzaExtension. Definition at line 138 of file pubsubevent.cpp.

const ItemOperationList& items (   )  const [inline]

Returns the list of ItemOperations for EventItems(Retract) notification. Returns: The list of ItemOperations. Definition at line 93 of file pubsubevent.h.

StanzaExtension* newInstance (  const Tag *  tag  )  const [inline, virtual]

Returns a new Instance of the derived type. Usually, for a derived class FooExtension, the implementation of this function looks like: StanzaExtension* FooExtension::newInstance( const Tag* tag ) const { return new FooExtension( tag ); } Returns: The derived extension's new instance. Implements StanzaExtension. Definition at line 106 of file pubsubevent.h.

const std::string& node (   )  [inline]

Returns the node's ID for which the notification is sent. Returns: The node's ID. Definition at line 100 of file pubsubevent.h.

const StringList& subscriptions (   )  const [inline]

Returns the list of subscription IDs for which this notification is valid. Returns: The list of subscription IDs. Definition at line 86 of file pubsubevent.h.

Tag * tag (   )  const [virtual]

Returns a Tag representation of the extension. Returns: A Tag representation of the extension. Implements StanzaExtension. Definition at line 144 of file pubsubevent.cpp.

PubSub::EventType type (   )  const [inline]

Returns the event's type. Returns: The event's type. Definition at line 79 of file pubsubevent.h.

---

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

• pubsubevent.h
• pubsubevent.cpp

---