Akonadi::Job

#include <job.h>

Inheritance diagram for Akonadi::Job:

[legend]

Public Types
enum	Error { ConnectionFailed = UserDefinedError , ProtocolVersionMismatch , UserCanceled , Unknown , UserError = UserDefinedError + 42 }

using	List = QList<Job *>

Public Types inherited from KJob
typedef QFlags< Capability >	Capabilities

enum	Capability

enum	Unit

Public Types inherited from QObject
typedef	QObjectList

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 &message)

void	percentChanged (KJob *job, unsigned long percent)

void	processedAmountChanged (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	totalAmountChanged (KJob *job, KJob::Unit unit, qulonglong amount)

void	totalSize (KJob *job, qulonglong size)

void	warning (KJob *job, const QString &message)

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

qint64	elapsedTime () const

int	error () const

QString	errorText () const

bool	exec ()

bool	isAutoDelete () const

bool	isFinishedNotificationHidden () const

bool	isStartedWithExec () const

bool	isSuspended () const

unsigned long	percent () const

Q_SCRIPTABLE qulonglong	processedAmount (Unit unit) const

void	setAutoDelete (bool autodelete)

void	setFinishedNotificationHidden (bool hide=true)

void	setUiDelegate (KJobUiDelegate *delegate)

Q_SCRIPTABLE qulonglong	totalAmount (Unit unit) const

KJobUiDelegate *	uiDelegate () 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 Slots
void	slotResult (KJob *job) override

Protected Slots inherited from KCompositeJob
virtual void	slotInfoMessage (KJob *job, const QString &message)

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)

bool	isFinished () const

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	setProgressUnit (Unit unit)

void	setTotalAmount (Unit unit, qulonglong amount)

void	startElapsedTimer ()

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)

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Slots inherited from KJob
bool	kill (KJob::KillVerbosity verbosity=KJob::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 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)

Public Attributes inherited from KJob
	Bytes

	Directories

	Files

	Items

	Killable

	NoCapabilities

	Suspendable

	UnitsCount

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.nosp@m.se@k.nosp@m.de.or.nosp@m.g, Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org, Marc Mutz mutz@.nosp@m.kde..nosp@m.org

Definition at line 80 of file job.h.

Member Typedef Documentation

◆ List

using Akonadi::Job::List = QList<Job *>

Describes a list of jobs.

Definition at line 91 of file job.h.

Member Enumeration Documentation

◆ Error

enum Akonadi::Job::Error

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::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

parent The parent object, job or session.

Definition at line 290 of file job.cpp.

◆ ~Job()

Job::~Job ( )

override

Destroys the job.

Definition at line 304 of file job.cpp.

Member Function Documentation

◆ aboutToStart

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

signal

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

Parameters

job	The started job.

◆ addSubjob()

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

job	The new subjob.

Reimplemented from KCompositeJob.

Reimplemented in Akonadi::TransactionSequence.

Definition at line 355 of file job.cpp.

◆ doHandleResponse()

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

tag	The tag of the corresponding command, empty if this is an untagged response.
response	The 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::CollectionCopyJob, Akonadi::CollectionCreateJob, Akonadi::CollectionDeleteJob, Akonadi::CollectionFetchJob, Akonadi::CollectionModifyJob, Akonadi::CollectionMoveJob, Akonadi::CollectionStatisticsJob, Akonadi::ItemCopyJob, Akonadi::ItemCreateJob, Akonadi::ItemDeleteJob, Akonadi::ItemFetchJob, Akonadi::ItemModifyJob, Akonadi::ItemMoveJob, Akonadi::ItemSearchJob, Akonadi::LinkJob, Akonadi::SearchCreateJob, Akonadi::TagCreateJob, Akonadi::TagDeleteJob, Akonadi::TagFetchJob, Akonadi::TagModifyJob, and Akonadi::UnlinkJob.

Definition at line 381 of file job.cpp.

◆ doKill()

bool Job::doKill ( )

overrideprotectedvirtual

Kills the execution of the job.

Reimplemented from KJob.

Definition at line 317 of file job.cpp.

◆ doStart()

virtual void Akonadi::Job::doStart ( )

protectedpure virtual

This method must be reimplemented in the concrete jobs.

It will be called after the job has been started and a connection to the Akonadi backend has been established.

Implemented in Akonadi::CollectionCopyJob, Akonadi::CollectionCreateJob, Akonadi::CollectionDeleteJob, Akonadi::CollectionFetchJob, Akonadi::CollectionModifyJob, Akonadi::CollectionMoveJob, Akonadi::CollectionPathResolver, Akonadi::CollectionStatisticsJob, Akonadi::ItemCopyJob, Akonadi::ItemCreateJob, Akonadi::ItemDeleteJob, Akonadi::ItemFetchJob, Akonadi::ItemModifyJob, Akonadi::ItemMoveJob, Akonadi::ItemSearchJob, Akonadi::ItemSync, Akonadi::LinkJob, Akonadi::SearchCreateJob, Akonadi::SpecialCollectionsRequestJob, Akonadi::TagCreateJob, Akonadi::TagDeleteJob, Akonadi::TagFetchJob, Akonadi::TagModifyJob, Akonadi::TransactionSequence, Akonadi::TrashJob, Akonadi::TrashRestoreJob, Akonadi::UnlinkJob, and Akonadi::XmlWriteJob.

◆ emitWriteFinished()

void Job::emitWriteFinished ( )

protected

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

See also: writeFinished()

Definition at line 409 of file job.cpp.

◆ errorString()

QString Job::errorString ( ) const

nodiscardfinalvirtual

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

Reimplemented from KJob.

Definition at line 328 of file job.cpp.

◆ removeSubjob()

bool Job::removeSubjob ( KJob * job )

overrideprotectedvirtual

Removes the given subjob of this job.

Parameters

job	The subjob to remove.

Reimplemented from KCompositeJob.

Definition at line 369 of file job.cpp.

◆ slotResult

void Job::slotResult ( KJob * job )

overrideprotectedslot

Definition at line 390 of file job.cpp.

◆ start()

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 313 of file job.cpp.

◆ writeFinished

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

job This job.

See also: emitWriteFinished()

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Akonadi

Akonadi::Job

Public Types

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ List

Member Enumeration Documentation

◆ Error

Constructor & Destructor Documentation

◆ Job()

◆ ~Job()

Member Function Documentation

◆ aboutToStart

◆ addSubjob()

◆ doHandleResponse()

◆ doKill()

◆ doStart()

◆ emitWriteFinished()

◆ errorString()

◆ removeSubjob()

◆ slotResult

◆ start()

◆ writeFinished