• Skip to content
  • Skip to link menu
KDE 4.5 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

  • Akonadi
  • Akonadi::PreprocessorBase
Public Types | Public Member Functions | Protected Member Functions

Akonadi::PreprocessorBase Class Reference

The base class for all Akonadi preprocessor agents. More...

#include <preprocessorbase.h>

Inheritance diagram for Akonadi::PreprocessorBase:
Inheritance graph
[legend]

List of all members.

Public Types

enum  ProcessingResult { ProcessingCompleted, ProcessingDelayed, ProcessingFailed, ProcessingRefused }

Public Member Functions

ItemFetchScope & fetchScope ()
void finishProcessing (ProcessingResult result)
virtual ProcessingResult processItem (const Item &item)=0
void setFetchScope (const ItemFetchScope &fetchScope)

Protected Member Functions

 PreprocessorBase (const QString &id)
virtual ~PreprocessorBase ()

Detailed Description

The base class for all Akonadi preprocessor agents.

This class should be used as a base class by all preprocessor agents since it encapsulates large parts of the protocol between preprocessor agent, agent manager and the Akonadi storage.

Preprocessor agents are special agents that are informed about newly added items before any other agents. This allows them to do filtering on the items or any other task that shall be done before the new item is visible in the Akonadi storage system.

The method all the preprocessors must implement is processItem().

Author:
Szymon Stefanek <s.stefanek@gmail.com>
Since:
4.4

Definition at line 55 of file preprocessorbase.h.


Member Enumeration Documentation

enum Akonadi::PreprocessorBase::ProcessingResult

Describes the possible return values of the processItem() method.

Enumerator:
ProcessingCompleted 

Processing completed successfully for this item.

The Akonadi server will push in a new item when it's available.

ProcessingDelayed 

Processing was delayed to a later stage.

This must be returned when implementing asynchronous preprocessing.

If this value is returned, finishProcessing() has to be called when processing is done.

ProcessingFailed 

Processing for this item failed (and the failure is unrecoverable).

The Akonadi server will push in a new item when it's available, after possibly logging the failure.

ProcessingRefused 

Processing for this item was refused.

This is very similar to ProcessingFailed above but additionally remarks that the item that the Akonadi server pushed in wasn't meant for this Preprocessor. The Akonadi server will push in a new item when it's available, after possibly logging the failure and maybe taking some additional action.

Definition at line 63 of file preprocessorbase.h.


Constructor & Destructor Documentation

Akonadi::PreprocessorBase::PreprocessorBase ( const QString &  id  )  [protected]

Creates a new preprocessor base agent.

Parameters:
id The instance id of the preprocessor base agent.
virtual Akonadi::PreprocessorBase::~PreprocessorBase (  )  [protected, virtual]

Destroys the preprocessor base agent.


Member Function Documentation

ItemFetchScope& Akonadi::PreprocessorBase::fetchScope (  ) 

Returns the item fetch scope.

Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.

Returns:
a reference to the current item fetch scope
See also:
setFetchScope() for replacing the current item fetch scope
void Akonadi::PreprocessorBase::finishProcessing ( ProcessingResult  result  ) 

This method must be called if processing is implemented asynchronously.

You should call it when you have completed the processing or if an abortRequest() signal arrives (and in this case you will probably use ProcessingFailed as result).

Valid values for result are ProcessingCompleted, PocessingRefused and ProcessingFailed. Passing any other value will lead to a runtime assertion.

virtual ProcessingResult Akonadi::PreprocessorBase::processItem ( const Item &  item  )  [pure virtual]

This method must be implemented by every preprocessor subclass.

It must realize the preprocessing of the given item.

The Akonadi server will push in for preprocessing any newly created item: it's your responsibility to decide if you want to process the item or not.

The method should return ProcessingCompleted on success, ProcessingDelayed if processing is implemented asynchronously and ProcessingRefused or ProcessingFailed if the processing didn't complete.

If your operation is asynchronous then you should also connect to the abortRequested() signal and handle it appropriately (as the server MAY abort your async job if it decides that it's taking too long).

void Akonadi::PreprocessorBase::setFetchScope ( const ItemFetchScope &  fetchScope  ) 

Sets the item fetch scope.

The ItemFetchScope controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.

Parameters:
fetchScope The new scope for item fetch operations.
See also:
fetchScope()

The documentation for this class was generated from the following file:
  • preprocessorbase.h

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal