Akonadi::PreprocessorBase Class Reference

#include <preprocessorbase.h>

Inheritance diagram for Akonadi::PreprocessorBase:

Public Types
enum	ProcessingResult { ProcessingCompleted , ProcessingDelayed , ProcessingFailed , ProcessingRefused }
Public Types inherited from Akonadi::AgentBase
enum	Status { Idle = 0 , Running , Broken , NotConfigured }
Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
ItemFetchScope &	fetchScope ()
void	finishProcessing (ProcessingResult result)
virtual ProcessingResult	processItem (const Item &item)=0
void	setFetchScope (const ItemFetchScope &fetchScope)
Public Member Functions inherited from Akonadi::AgentBase
QStringList	activities () const
bool	activitiesEnabled () const
QString	agentName () const
virtual void	cleanup ()
QString	identifier () const
virtual int	progress () const
virtual QString	progressMessage () const
void	registerObserver (Observer *observer)
void	setActivities (const QStringList &activities)
void	setActivitiesEnabled (bool enabled)
void	setAgentName (const QString &name)
virtual int	status () const
virtual QString	statusMessage () const
WId	winIdForDialogs () const
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
	PreprocessorBase (const QString &id)
	~PreprocessorBase () override
Protected Member Functions inherited from Akonadi::AgentBase
	AgentBase (const QString &id)
	~AgentBase () override
virtual KAboutData	aboutData () const
virtual void	aboutToQuit ()
void	changeProcessed ()
ChangeRecorder *	changeRecorder () const
KSharedConfigPtr	config ()
virtual void	doSetOnline (bool online)
bool	isOnline () const
void	setNeedsNetwork (bool needsNetwork)
void	setOnline (bool state)
void	setTemporaryOffline (int makeOnlineInSeconds=300)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)
Protected Member Functions inherited from QDBusContext
bool	calledFromDBus () const const
QDBusConnection	connection () const const
bool	isDelayedReply () const const
const QDBusMessage &	message () const const
void	sendErrorReply (const QString &name, const QString &msg) const const
void	sendErrorReply (QDBusError::ErrorType type, const QString &msg) const const
void	setDelayedReply (bool enable) const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Signals inherited from Akonadi::AgentBase
void	abortRequested ()
void	advancedStatus (const QVariantMap &status)
void	agentActivitiesChanged (const QStringList &activities)
void	agentActivitiesEnabledChanged (bool enabled)
void	agentNameChanged (const QString &name)
void	configurationDialogAccepted ()
void	configurationDialogRejected ()
void	error (const QString &message)
void	onlineChanged (bool online)
void	percent (int progress)
void	reloadConfiguration ()
void	status (int status, const QString &message=QString())
void	warning (const QString &message)
Public Slots inherited from Akonadi::AgentBase
virtual void	configure (WId windowId)
Static Public Member Functions inherited from Akonadi::AgentBase
template<typename T >
static int	init (int argc, char **argv)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

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.ste.nosp@m.fane.nosp@m.k@gma.nosp@m.il.c.nosp@m.om

Since

4.4

Definition at line 40 of file preprocessorbase.h.

Member Enumeration Documentation

ProcessingResult

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 48 of file preprocessorbase.h.

Constructor & Destructor Documentation

PreprocessorBase()

PreprocessorBase::PreprocessorBase ( const QString & id )

protected

Creates a new preprocessor base agent.

Parameters

id	The instance id of the preprocessor base agent.

Definition at line 15 of file preprocessorbase.cpp.

~PreprocessorBase()

PreprocessorBase::~PreprocessorBase ( )

overrideprotected

Destroys the preprocessor base agent.

Definition at line 20 of file preprocessorbase.cpp.

Member Function Documentation

fetchScope()

ItemFetchScope & 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

Definition at line 43 of file preprocessorbase.cpp.

finishProcessing()

void PreprocessorBase::finishProcessing

(

ProcessingResult

result

)

This method must be called if processing is implemented asynchronously.

Parameters

result

the processing result 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.

Definition at line 24 of file preprocessorbase.cpp.

processItem()

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

pure virtual

This method must be implemented by every preprocessor subclass.

Parameters

item	the item to process 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).

setFetchScope()

void 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()

Definition at line 36 of file preprocessorbase.cpp.

---

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

• preprocessorbase.h
• preprocessorbase.cpp