Akonadi::Job

#include <job.h>

Inheritance diagram for Akonadi::Job:

Public Types

enum  Error {
  ConnectionFailed = UserDefinedError, ProtocolVersionMismatch, UserCanceled, Unknown,
  UserError = UserDefinedError + 42
}
 
typedef QList< Job * > List
 
- Public Types inherited from KJob
typedef QFlags< CapabilityCapabilities
 
enum  Capability
 
enum  Unit
 

Signals

void aboutToStart (Akonadi::Job *job)
 
void writeFinished (Akonadi::Job *job)
 
- Signals inherited from KJob
void description (KJob *job, const QString &title, const QPair< QString, QString > &field1=QPair< QString, QString >(), const QPair< QString, QString > &field2=QPair< QString, QString >())
 
void finished (KJob *job)
 
void infoMessage (KJob *job, const QString &plain, const QString &rich=QString())
 
void percent (KJob *job, unsigned long percent)
 
void processedAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void processedSize (KJob *job, qulonglong size)
 
void result (KJob *job)
 
void resumed (KJob *job)
 
void speed (KJob *job, unsigned long speed)
 
void suspended (KJob *job)
 
void totalAmount (KJob *job, KJob::Unit unit, qulonglong amount)
 
void totalSize (KJob *job, qulonglong size)
 
void warning (KJob *job, const QString &plain, const QString &rich=QString())
 

Public Member Functions

 Job (QObject *parent=nullptr)
 
 ~Job () override
 
QString errorString () const final
 
void start () override
 
- Public Member Functions inherited from KCompositeJob
 KCompositeJob (QObject *parent=nullptr)
 
- Public Member Functions inherited from KJob
 KJob (QObject *parent=nullptr)
 
Capabilities capabilities () const
 
int error () const
 
QString errorText () const
 
bool exec ()
 
bool isAutoDelete () const
 
bool isSuspended () const
 
unsigned long percent () const
 
Q_SCRIPTABLE qulonglong processedAmount (Unit unit) const
 
void setAutoDelete (bool autodelete)
 
void setUiDelegate (KJobUiDelegate *delegate)
 
Q_SCRIPTABLE qulonglong totalAmount (Unit unit) const
 
KJobUiDelegateuiDelegate () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Protected Slots

void slotResult (KJob *job) override
 
- Protected Slots inherited from KCompositeJob
virtual void slotInfoMessage (KJob *job, const QString &plain, const QString &rich)
 
virtual void slotResult (KJob *job)
 

Protected Member Functions

bool addSubjob (KJob *job) override
 
virtual bool doHandleResponse (qint64 tag, const Protocol::CommandPtr &response)
 
bool doKill () override
 
virtual void doStart ()=0
 
void emitWriteFinished ()
 
bool removeSubjob (KJob *job) override
 
- Protected Member Functions inherited from KCompositeJob
void clearSubjobs ()
 
bool hasSubjobs () const
 
const QList< KJob * > & subjobs () const
 
- Protected Member Functions inherited from KJob
virtual bool doResume ()
 
virtual bool doSuspend ()
 
void emitPercent (qulonglong processedAmount, qulonglong totalAmount)
 
void emitResult ()
 
void emitSpeed (unsigned long speed)
 
void setCapabilities (Capabilities capabilities)
 
void setError (int errorCode)
 
void setErrorText (const QString &errorText)
 
void setPercent (unsigned long percentage)
 
void setProcessedAmount (Unit unit, qulonglong amount)
 
void setTotalAmount (Unit unit, qulonglong amount)
 
- 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Slots inherited from KJob
bool kill (KillVerbosity verbosity=Quietly)
 
bool resume ()
 
bool suspend ()
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from KJob
 Bytes
 
 Directories
 
 Files
 
 Items
 
 Killable
 
 NoCapabilities
 
 Suspendable
 
- Public Attributes inherited from QObject
typedef QObjectList
 

Detailed Description

Base class for all actions in the Akonadi storage.

This class encapsulates a request to the pim storage service, the code looks like

Akonadi::Job *job = new Akonadi::SomeJob( some parameter );
connect( job, SIGNAL(result(KJob*)),
this, SLOT(slotResult(KJob*)) );

The job is queued for execution as soon as the event loop is entered again.

And the slotResult is usually at least:

if ( job->error() ) {
// handle error...
}

With the synchronous interface the code looks like

Akonadi::SomeJob *job = new Akonadi::SomeJob( some parameter );
if ( !job->exec() ) {
qDebug() << "Error:" << job->errorString();
} else {
// do something
}
Warning
Using the synchronous method is error prone, use this only if the asynchronous access is not possible. See the documentation of KJob::exec() for more details.

Subclasses must reimplement doStart().

Note
KJob-derived objects delete itself, it is thus not possible to create job objects on the stack!
Author
Volker Krause vkrau[email protected][email protected][email protected]de.or[email protected]g, Tobias Koenig tokoe[email protected]@kde[email protected].org, Marc Mutz [email protected][email protected]kde.[email protected]org

Definition at line 80 of file job.h.

Member Typedef Documentation

Describes a list of jobs.

Definition at line 91 of file job.h.

Member Enumeration Documentation

Describes the error codes that can be emitted by this class.

Subclasses can provide additional codes, starting from UserError onwards

Enumerator
ConnectionFailed 

The connection to the Akonadi server failed.

ProtocolVersionMismatch 

The server protocol version is too old or too new.

UserCanceled 

The user canceled this job.

Unknown 

Unknown error.

UserError 

Starting point for error codes defined by sub-classes.

Definition at line 98 of file job.h.

Constructor & Destructor Documentation

Job::Job ( QObject parent = nullptr)
explicit

Creates a new job.

If the parent object is a Job object, the new job will be a subjob of parent. If the parent object is a Session object, it will be used for server communication instead of the default session.

Parameters
parentThe parent object, job or session.

Definition at line 285 of file job.cpp.

Job::~Job ( )
override

Destroys the job.

Definition at line 299 of file job.cpp.

Member Function Documentation

void Akonadi::Job::aboutToStart ( Akonadi::Job job)
signal

This signal is emitted directly before the job will be started.

Parameters
jobThe started job.
bool Job::addSubjob ( KJob job)
overrideprotectedvirtual

Adds the given job as a subjob to this job.

This method is automatically called if you construct a job using another job as parent object. The base implementation does the necessary setup to share the network connection with the backend.

Parameters
jobThe new subjob.

Reimplemented from KCompositeJob.

Reimplemented in Akonadi::TransactionSequence.

Definition at line 352 of file job.cpp.

bool Akonadi::Job::doHandleResponse ( qint64  tag,
const Protocol::CommandPtr response 
)
protectedvirtual

This method should be reimplemented in the concrete jobs in case you want to handle incoming data.

It will be called on received data from the backend. The default implementation does nothing.

Parameters
tagThe tag of the corresponding command, empty if this is an untagged response.
responseThe received response
Returns
Implementations should return true if the last response was processed and the job can emit result. Return false if more responses from server are expected.

Reimplemented in Akonadi::ItemFetchJob, Akonadi::ItemSearchJob, Akonadi::ItemModifyJob, Akonadi::CollectionFetchJob, Akonadi::SearchCreateJob, Akonadi::ItemDeleteJob, Akonadi::ItemCreateJob, Akonadi::TagFetchJob, Akonadi::CollectionModifyJob, Akonadi::ItemMoveJob, Akonadi::CollectionStatisticsJob, Akonadi::ItemCopyJob, Akonadi::CollectionDeleteJob, Akonadi::LinkJob, Akonadi::UnlinkJob, Akonadi::CollectionCreateJob, Akonadi::CollectionCopyJob, Akonadi::RelationFetchJob, Akonadi::CollectionMoveJob, Akonadi::TagCreateJob, Akonadi::TagModifyJob, Akonadi::RelationCreateJob, Akonadi::RelationDeleteJob, and Akonadi::TagDeleteJob.

Definition at line 372 of file job.cpp.

bool Job::doKill ( )
overrideprotectedvirtual

Kills the execution of the job.

Reimplemented from KJob.

Definition at line 314 of file job.cpp.

void Job::emitWriteFinished ( )
protected

Call this method to indicate that this job will not call writeData() again.

See also
writeFinished()

Definition at line 398 of file job.cpp.

QString Job::errorString ( ) const
finalvirtual

Returns the error string, if there has been an error, an empty string otherwise.

Reimplemented from KJob.

Definition at line 325 of file job.cpp.

bool Job::removeSubjob ( KJob job)
overrideprotectedvirtual

Removes the given subjob of this job.

Parameters
jobThe subjob to remove.

Reimplemented from KCompositeJob.

Definition at line 362 of file job.cpp.

void Job::start ( )
overridevirtual

Jobs are started automatically once entering the event loop again, no need to explicitly call this.

Implements KJob.

Definition at line 310 of file job.cpp.

void Akonadi::Job::writeFinished ( Akonadi::Job job)
signal

This signal is emitted if the job has finished all write operations, ie.

if this signal is emitted, the job guarantees to not call writeData() again. Do not emit this signal directly, call emitWriteFinished() instead.

Parameters
jobThis job.
See also
emitWriteFinished()

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Fri Jul 10 2020 23:14:22 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.