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

akonadi

  • akonadi
servermanager.h
1/*
2 Copyright (c) 2008 Volker Krause <vkrause@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_SERVERMANAGER_H
21#define AKONADI_SERVERMANAGER_H
22
23#include "akonadi_export.h"
24
25#include <QtCore/QObject>
26#include <QtCore/QMetaType>
27
28namespace Akonadi {
29
30class ServerManagerPrivate;
31
42class AKONADI_EXPORT ServerManager : public QObject
43{
44 Q_OBJECT
45public:
50 enum State {
51 NotRunning,
52 Starting,
53 Running,
54 Stopping,
55 Broken,
56 Upgrading
57 };
58
66 static bool start();
67
75 static bool stop();
76
82 static void showSelfTestDialog(QWidget *parent);
83
89 static bool isRunning();
90
95 static State state();
96
103 static QString instanceIdentifier();
104
109 static bool hasInstanceIdentifier();
110
115 enum ServiceType {
116 Server,
117 Control,
118 ControlLock,
119 UpgradeIndicator
120 };
121
129 static QString serviceName(ServiceType serviceType);
130
135 enum ServiceAgentType {
136 Agent,
137 Resource,
138 Preprocessor
139 };
140
148 static QString agentServiceName(ServiceAgentType agentType, const QString &identifier);
149
156 static QString addNamespace(const QString &string);
157
162 static ServerManager *self();
163
164Q_SIGNALS:
168 void started();
169
173 void stopped();
174
180 void stateChanged(Akonadi::ServerManager::State state);
181
182private:
183 //@cond PRIVATE
184 friend class ServerManagerPrivate;
185 ServerManager(ServerManagerPrivate *dd);
186 ServerManagerPrivate *const d;
187 Q_PRIVATE_SLOT(d, void serviceOwnerChanged(const QString &, const QString &, const QString &))
188 Q_PRIVATE_SLOT(d, void checkStatusChanged())
189 Q_PRIVATE_SLOT(d, void timeout())
190 //@endcond
191};
192
193}
194
195Q_DECLARE_METATYPE(Akonadi::ServerManager::State)
196
197#endif
Akonadi::Control
Provides methods to control the Akonadi server process.
Definition control.h:63
Akonadi::ServerManager
Provides methods to control the Akonadi server process.
Definition servermanager.h:43
Akonadi::ServerManager::started
void started()
Emitted whenever the server becomes fully operational.
Akonadi::ServerManager::ServiceType
ServiceType
Types of known D-Bus services.
Definition servermanager.h:115
Akonadi::ServerManager::stopped
void stopped()
Emitted whenever the server becomes unavailable.
Akonadi::ServerManager::ServiceAgentType
ServiceAgentType
Known agent types.
Definition servermanager.h:135
Akonadi::ServerManager::State
State
Enum for the various states the server can be in.
Definition servermanager.h:50
Akonadi::ServerManager::Running
@ Running
Server is running and operational.
Definition servermanager.h:53
Akonadi::ServerManager::Starting
@ Starting
Server was started but is not yet running.
Definition servermanager.h:52
Akonadi::ServerManager::Broken
@ Broken
Server is not operational and an error has been detected.
Definition servermanager.h:55
Akonadi::ServerManager::NotRunning
@ NotRunning
Server is not running, could be no one started it yet or it failed to start.
Definition servermanager.h:51
Akonadi::ServerManager::Stopping
@ Stopping
Server is shutting down.
Definition servermanager.h:54
Akonadi::ServerManager::stateChanged
void stateChanged(Akonadi::ServerManager::State state)
Emitted whenever the server state changes.
Akonadi
FreeBusyManager::Singleton.
Definition actionstatemanager_p.h:28
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 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
  • 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