• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • JobPrivate
Public Member Functions | Public Attributes | List of all members
Akonadi::JobPrivate Class Reference

#include <job_p.h>

Inheritance diagram for Akonadi::JobPrivate:
Akonadi::LinkJobImpl< UnlinkJob > Akonadi::MoveJobImpl< Collection, CollectionMoveJob > Akonadi::MoveJobImpl< Item, ItemMoveJob > Akonadi::ItemModifyJobPrivate Akonadi::LinkJobImpl< LinkJob > Akonadi::MoveJobImpl< T, MoveJob >

Public Member Functions

 JobPrivate (Job *parent)
 
virtual void aboutToFinish ()
 
void delayedEmitResult ()
 
virtual void doUpdateItemRevision (Akonadi::Item::Id, int oldRevision, int newRevision)
 
void handleResponse (const QByteArray &tag, const QByteArray &data)
 
void init (QObject *parent)
 
void itemRevisionChanged (Akonadi::Item::Id itemId, int oldRevision, int newRevision)
 
virtual QString jobDebuggingString () const
 
void lostConnection ()
 
QByteArray newTag ()
 
int protocolVersion () const
 
void signalCreationToJobTracker ()
 
void signalStartedToJobTracker ()
 
void slotSubJobAboutToStart (Akonadi::Job *)
 
void startNext ()
 
void startQueued ()
 
QByteArray tag () const
 
void updateItemRevision (Akonadi::Item::Id itemId, int oldRevision, int newRevision)
 
void writeData (const QByteArray &data)
 

Public Attributes

Job * mCurrentSubJob
 
Job * mParentJob
 
Session * mSession
 
bool mStarted
 
QByteArray mTag
 
bool mWriteFinished
 
Job * q_ptr
 

Detailed Description

Definition at line 31 of file job_p.h.

Constructor & Destructor Documentation

◆ JobPrivate()

Akonadi::JobPrivate::JobPrivate ( Job *  parent)
inlineexplicit

Definition at line 34 of file job_p.h.

◆ ~JobPrivate()

virtual Akonadi::JobPrivate::~JobPrivate ( )
inlinevirtual

Definition at line 43 of file job_p.h.

Member Function Documentation

◆ aboutToFinish()

virtual void Akonadi::JobPrivate::aboutToFinish ( )
virtual

This method is called right before result() and finished() signals are emitted.

Overwrite this method in your job if you need to emit some signals or process some data before the job finishes.

Default implementation does nothing.

◆ doUpdateItemRevision()

virtual void Akonadi::JobPrivate::doUpdateItemRevision ( Akonadi::Item::Id  ,
int  oldRevision,
int  newRevision 
)
virtual

Overwrite this if your job does operations with conflict detection and update the item revisions if your items are affected.

The default implementation does nothing.

◆ itemRevisionChanged()

void Akonadi::JobPrivate::itemRevisionChanged ( Akonadi::Item::Id  itemId,
int  oldRevision,
int  newRevision 
)

Notify following jobs about item revision changes.

This is used to avoid phantom conflicts between pipelined modify jobs on the same item.

Parameters
itemIDthe id of the item which has changed
oldRevisionthe old item revision
newRevisionthe new item revision

◆ jobDebuggingString()

virtual QString Akonadi::JobPrivate::jobDebuggingString ( ) const
inlinevirtual

Definition at line 60 of file job_p.h.

◆ newTag()

QByteArray Akonadi::JobPrivate::newTag ( )

Returns a new unique command tag for communication with the backend.

◆ tag()

QByteArray Akonadi::JobPrivate::tag ( ) const

Return the tag used for the request.

◆ updateItemRevision()

void Akonadi::JobPrivate::updateItemRevision ( Akonadi::Item::Id  itemId,
int  oldRevision,
int  newRevision 
)

Propagate item revision changes to this job and its sub-jobs.

◆ writeData()

void Akonadi::JobPrivate::writeData ( const QByteArray &  data)

Sends raw data to the backend.

Member Data Documentation

◆ mCurrentSubJob

Job* Akonadi::JobPrivate::mCurrentSubJob

Definition at line 113 of file job_p.h.

◆ mParentJob

Job* Akonadi::JobPrivate::mParentJob

Definition at line 112 of file job_p.h.

◆ mSession

Session* Akonadi::JobPrivate::mSession

Definition at line 115 of file job_p.h.

◆ mStarted

bool Akonadi::JobPrivate::mStarted

Definition at line 117 of file job_p.h.

◆ mTag

QByteArray Akonadi::JobPrivate::mTag

Definition at line 114 of file job_p.h.

◆ mWriteFinished

bool Akonadi::JobPrivate::mWriteFinished

Definition at line 116 of file job_p.h.

◆ q_ptr

Job* Akonadi::JobPrivate::q_ptr

Definition at line 109 of file job_p.h.


The documentation for this class was generated from the following file:
  • job_p.h
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

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

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal