LastActivity Class Reference

This is an implementation of JEP-0012 (Last Activity) for both clients and components. More...

#include <lastactivity.h>

Inherits IqHandler.

Inheritance diagram for LastActivity:

Inheritance graph
[legend]
Collaboration diagram for LastActivity:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LastActivity (ClientBase *parent, Disco *disco)
virtual ~LastActivity ()
void query (const JID &jid)
void registerLastActivityHandler (LastActivityHandler *lah)
void removeLastActivityHandler ()
void resetIdleTimer ()
virtual bool handleIqID (Stanza *stanza, int context)
virtual bool handleIq (Stanza *stanza)

Detailed Description

This is an implementation of JEP-0012 (Last Activity) for both clients and components.

LastActivity can be used to query remote entities about their last activity time as well as answer incoming last-activity-queries.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.6

Definition at line 37 of file lastactivity.h.


Constructor & Destructor Documentation

LastActivity ( ClientBase parent,
Disco disco 
)

Constructs a new LastActivity object.

Definition at line 26 of file lastactivity.cpp.

~LastActivity (  )  [virtual]

Virtual destructor.

Definition at line 34 of file lastactivity.cpp.


Member Function Documentation

bool handleIq ( Stanza stanza  )  [virtual]

Reimplement this function if you want to be notified about incoming IQs.

Parameters:
stanza The complete Stanza.
Returns:
Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, a 'error' will be sent.

Implements IqHandler.

Definition at line 53 of file lastactivity.cpp.

bool handleIqID ( Stanza stanza,
int  context 
) [virtual]

Reimplement this function if you want to be notified about incoming IQs with a specific value of the id attribute. You have to enable tracking of those IDs using Client::trackID(). This is usually useful for IDs that generate a positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work.

Parameters:
stanza The complete Stanza.
context A value to restore context, stored with ClientBase::trackID().
Returns:
Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, a 'error' will be sent.

Implements IqHandler.

Definition at line 97 of file lastactivity.cpp.

void query ( const JID jid  ) 

Queries the given JID for their last activity. The result can be received by reimplementing LastActivityHandler::handleLastActivityResult() and LastActivityHandler::handleLastActivityError().

Definition at line 38 of file lastactivity.cpp.

void registerLastActivityHandler ( LastActivityHandler lah  )  [inline]

Use this function to register an object as handler for incoming results of Last-Activity queries. Only one handler is possible at a time.

Parameters:
lah The object to register as handler.

Definition at line 63 of file lastactivity.h.

void removeLastActivityHandler (  )  [inline]

Use this function to un-register the LastActivityHandler set earlier.

Definition at line 68 of file lastactivity.h.

void resetIdleTimer (  ) 

Use this function to reset the idle timer. By default the number of seconds since the instantiation will be used.

Definition at line 122 of file lastactivity.cpp.


The documentation for this class was generated from the following files:
Generated on Sun Sep 24 21:57:39 2006 for gloox by  doxygen 1.4.7