/usr/include/akonadi/servermanager.h is in kdepimlibs5-dev 4:4.14.10-1ubuntu7.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 | /*
Copyright (c) 2008 Volker Krause <vkrause@kde.org>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_SERVERMANAGER_H
#define AKONADI_SERVERMANAGER_H
#include "akonadi_export.h"
#include <QtCore/QObject>
#include <QtCore/QMetaType>
namespace Akonadi {
class ServerManagerPrivate;
/**
* @short Provides methods to control the Akonadi server process.
*
* Asynchronous, low-level control of the Akonadi server.
* Akonadi::Control provides a synchronous interface to some of the methods in here.
*
* @author Volker Krause <vkrause@kde.org>
* @see Akonadi::Control
* @since 4.2
*/
class AKONADI_EXPORT ServerManager : public QObject
{
Q_OBJECT
public:
/**
* Enum for the various states the server can be in.
* @since 4.5
*/
enum State {
NotRunning, ///< Server is not running, could be no one started it yet or it failed to start.
Starting, ///< Server was started but is not yet running.
Running, ///< Server is running and operational.
Stopping, ///< Server is shutting down.
Broken, ///< Server is not operational and an error has been detected.
Upgrading ///< Server is performing a database upgrade as part of a new startup.
};
/**
* Starts the server. This method returns imediately and does not wait
* until the server is actually up and running.
* @return @c true if the start was possible (which not necessarily means
* the server is really running though) and @c false if an immediate error occurred.
* @see Akonadi::Control::start()
*/
static bool start();
/**
* Stops the server. This methods returns immediately after the shutdown
* command has been send and does not wait until the server is actually
* shut down.
* @return @c true if the shutdown command was sent successfully, @c false
* otherwise
*/
static bool stop();
/**
* Shows the Akonadi self test dialog, which tests Akonadi for various problems
* and reports these to the user if.
* @param parent the parent widget for the dialog
*/
static void showSelfTestDialog(QWidget *parent);
/**
* Checks if the server is available currently. For more detailed status information
* see state().
* @see state()
*/
static bool isRunning();
/**
* Returns the state of the server.
* @since 4.5
*/
static State state();
/**
* Returns the identifier of the Akonadi instance we are connected to. This is usually
* an empty string (representing the default instance), unless you have explicitly set
* the AKONADI_INSTANCE environment variable to connect to a different one.
* @since 4.10
*/
static QString instanceIdentifier();
/**
* Returns @c true if we are connected to a non-default Akonadi server instance.
* @since 4.10
*/
static bool hasInstanceIdentifier();
/**
* Types of known D-Bus services.
* @since 4.10
*/
enum ServiceType {
Server,
Control,
ControlLock,
UpgradeIndicator
};
/**
* Returns the namespaced D-Bus service name for @p serviceType.
* Use this rather the raw service name strings in order to support usage of a non-default
* instance of the Akonadi server.
* @param serviceType the service type for which to return the D-Bus name
* @since 4.10
*/
static QString serviceName(ServiceType serviceType);
/**
* Known agent types.
* @since 4.10
*/
enum ServiceAgentType {
Agent,
Resource,
Preprocessor
};
/**
* Returns the namespaced D-Bus service name for an agent of type @p agentType with agent
* identifier @p identifier.
* @param agentType the agent type to use for D-Bus base name
* @param identifier the agent identifier to include in the D-Bus name
* @since 4.10
*/
static QString agentServiceName(ServiceAgentType agentType, const QString &identifier);
/**
* Adds the multi-instance namespace to @p string if required (with '_' as separator).
* Use whenever a multi-instance safe name is required (configfiles, identifiers, ...).
* @param string the string to adapt
* @since 4.10
*/
static QString addNamespace(const QString &string);
/**
* Returns the singleton instance of this class, for connecting to its
* signals
*/
static ServerManager *self();
Q_SIGNALS:
/**
* Emitted whenever the server becomes fully operational.
*/
void started();
/**
* Emitted whenever the server becomes unavailable.
*/
void stopped();
/**
* Emitted whenever the server state changes.
* @param state the new server state
* @since 4.5
*/
void stateChanged(Akonadi::ServerManager::State state);
private:
//@cond PRIVATE
friend class ServerManagerPrivate;
ServerManager(ServerManagerPrivate *dd);
ServerManagerPrivate *const d;
Q_PRIVATE_SLOT(d, void serviceOwnerChanged(const QString &, const QString &, const QString &))
Q_PRIVATE_SLOT(d, void checkStatusChanged())
Q_PRIVATE_SLOT(d, void timeout())
//@endcond
};
}
Q_DECLARE_METATYPE(Akonadi::ServerManager::State)
#endif
|