gloox  1.0.1
Public Member Functions | List of all members
MessageEventFilter Class Reference

#include <messageeventfilter.h>

Inheritance diagram for MessageEventFilter:
Inheritance graph

Public Member Functions

 MessageEventFilter (MessageSession *parent)
virtual ~MessageEventFilter ()
void raiseMessageEvent (MessageEventType event)
void registerMessageEventHandler (MessageEventHandler *meh)
void removeMessageEventHandler ()
virtual void decorate (Message &msg)
virtual void filter (Message &msg)
- Public Member Functions inherited from MessageFilter
 MessageFilter (MessageSession *parent)
virtual ~MessageFilter ()
virtual void attachTo (MessageSession *session)

Detailed Description

This class adds Message Event (XEP-0022) support to a MessageSession.

This implementation of Message Events is fully transparent to the user of the class. If the remote entity does not request message events, MessageEventFilter will not send any, even if the user requests it. (This is required by the protocol specification.)

Jakob Schroeter

Definition at line 38 of file messageeventfilter.h.

Constructor & Destructor Documentation

Contstructs a new Message Event filter for a MessageSession.

parentThe MessageSession to decorate.

Definition at line 24 of file messageeventfilter.cpp.

~MessageEventFilter ( )

Virtual destructor.

Definition at line 30 of file messageeventfilter.cpp.

Member Function Documentation

void decorate ( Message msg)

This function receives a message right before it is sent out (there may be other filters which get to see the message after this filter, though).

msgThe tag to decorate. It contains the message to be sent.

Implements MessageFilter.

Definition at line 92 of file messageeventfilter.cpp.

void filter ( Message msg)

This function receives a message stanza right after it was received (there may be other filters which got to see the stanza before this filter, though).

msgThe complete message stanza.

Implements MessageFilter.

Definition at line 34 of file messageeventfilter.cpp.

void raiseMessageEvent ( MessageEventType  event)

Use this function to raise an event as defined in XEP-0022.

The Spec states that Message Events shall not be sent to an entity which did not request them. Reasonable effort is taken in this function to avoid spurious event sending. You should be safe to call this even if Message Events were not requested by the remote entity. However, calling raiseMessageEvent( MESSAGE_EVENT_COMPOSING ) for every keystroke still is discouraged. ;)
eventThe event to raise.

Definition at line 65 of file messageeventfilter.cpp.

void registerMessageEventHandler ( MessageEventHandler meh)

The MessageEventHandler registered here will receive Message Events according to XEP-0022.

mehThe MessageEventHandler to register.

Definition at line 102 of file messageeventfilter.cpp.

void removeMessageEventHandler ( )

This function clears the internal pointer to the MessageEventHandler. Message Events will not be delivered anymore after calling this function until another MessageEventHandler is registered.

Definition at line 107 of file messageeventfilter.cpp.

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