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

akonadi

  • sources
  • kde-4.12
  • kdepimlibs
  • akonadi
job_p.h
1 /*
2  Copyright (c) 2007 Tobias Koenig <tokoe@kde.org>
3 
4  This library is free software; you can redistribute it and/or modify it
5  under the terms of the GNU Library General Public License as published by
6  the Free Software Foundation; either version 2 of the License, or (at your
7  option) any later version.
8 
9  This library is distributed in the hope that it will be useful, but WITHOUT
10  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
12  License for more details.
13 
14  You should have received a copy of the GNU Library General Public License
15  along with this library; see the file COPYING.LIB. If not, write to the
16  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
17  02110-1301, USA.
18 */
19 
20 #ifndef AKONADI_JOB_P_H
21 #define AKONADI_JOB_P_H
22 
23 #include "session.h"
24 #include "item.h"
25 
26 namespace Akonadi {
27 
31 class JobPrivate
32 {
33  public:
34  explicit JobPrivate( Job *parent )
35  : q_ptr( parent ),
36  mCurrentSubJob( 0 ),
37  mSession( 0 ),
38  mWriteFinished( false ),
39  mStarted( false )
40  {
41  }
42 
43  virtual ~JobPrivate()
44  {
45  }
46 
47  void init( QObject *parent );
48 
49  void handleResponse( const QByteArray &tag, const QByteArray &data );
50  void startQueued();
51  void lostConnection();
52  void slotSubJobAboutToStart( Akonadi::Job* );
53  void startNext();
54  void signalCreationToJobTracker();
55  void signalStartedToJobTracker();
56  void delayedEmitResult();
57  /*
58  Returns a string to display in akonadi console's job tracker. E.g. item ID.
59  */
60  virtual QString jobDebuggingString() const { return QString(); }
64  QByteArray newTag();
65 
69  QByteArray tag() const;
70 
74  void writeData( const QByteArray &data );
75 
83  void itemRevisionChanged( Akonadi::Item::Id itemId, int oldRevision, int newRevision );
84 
88  void updateItemRevision( Akonadi::Item::Id itemId, int oldRevision, int newRevision );
89 
94  virtual void doUpdateItemRevision( Akonadi::Item::Id, int oldRevision, int newRevision );
95 
96  int protocolVersion() const;
97 
98  Job *q_ptr;
99  Q_DECLARE_PUBLIC( Job )
100 
101  Job *mParentJob;
102  Job *mCurrentSubJob;
103  QByteArray mTag;
104  Session* mSession;
105  bool mWriteFinished;
106  bool mStarted;
107 };
108 
109 }
110 
111 #endif
Akonadi::JobPrivate::doUpdateItemRevision
virtual void doUpdateItemRevision(Akonadi::Item::Id, int oldRevision, int newRevision)
Overwrite this if your job does operations with conflict detection and update the item revisions if y...
Akonadi::Job
Base class for all actions in the Akonadi storage.
Definition: job.h:86
Akonadi::JobPrivate::updateItemRevision
void updateItemRevision(Akonadi::Item::Id itemId, int oldRevision, int newRevision)
Propagate item revision changes to this job and its sub-jobs.
Akonadi::JobPrivate::itemRevisionChanged
void itemRevisionChanged(Akonadi::Item::Id itemId, int oldRevision, int newRevision)
Notify following jobs about item revision changes.
Akonadi::JobPrivate::tag
QByteArray tag() const
Return the tag used for the request.
Akonadi::Session
A communication session with the Akonadi storage.
Definition: session.h:59
Akonadi::JobPrivate::newTag
QByteArray newTag()
Returns a new unique command tag for communication with the backend.
Akonadi::JobPrivate::writeData
void writeData(const QByteArray &data)
Sends raw data to the backend.
Akonadi::JobPrivate
Definition: job_p.h:31
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:00:27 by doxygen 1.8.7 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 API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



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