akonadi
#include <servermanager.h>
Inherits QObject.
Public Types | |
enum | ServiceAgentType { Agent , Resource , Preprocessor } |
enum | ServiceType { Server , Control , ControlLock , UpgradeIndicator } |
enum | State { NotRunning , Starting , Running , Stopping , Broken , Upgrading } |
Signals | |
void | started () |
void | stateChanged (Akonadi::ServerManager::State state) |
void | stopped () |
Static Public Member Functions | |
static QString | addNamespace (const QString &string) |
static QString | agentServiceName (ServiceAgentType agentType, const QString &identifier) |
static bool | hasInstanceIdentifier () |
static QString | instanceIdentifier () |
static bool | isRunning () |
static ServerManager * | self () |
static QString | serviceName (ServiceType serviceType) |
static void | showSelfTestDialog (QWidget *parent) |
static bool | start () |
static State | state () |
static bool | stop () |
Detailed Description
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.
- See also
- Akonadi::Control
- Since
- 4.2
Definition at line 42 of file servermanager.h.
Member Enumeration Documentation
◆ ServiceAgentType
◆ ServiceType
◆ State
Enum for the various states the server can be in.
- Since
- 4.5
Definition at line 50 of file servermanager.h.
Member Function Documentation
◆ addNamespace()
|
static |
Adds the multi-instance namespace to string
if required (with '_' as separator).
Use whenever a multi-instance safe name is required (configfiles, identifiers, ...).
- Parameters
-
string the string to adapt
- Since
- 4.10
Definition at line 337 of file servermanager.cpp.
◆ agentServiceName()
|
static |
Returns the namespaced D-Bus service name for an agent of type agentType
with agent identifier identifier
.
- Parameters
-
agentType the agent type to use for D-Bus base name identifier the agent identifier to include in the D-Bus name
- Since
- 4.10
Definition at line 323 of file servermanager.cpp.
◆ hasInstanceIdentifier()
|
static |
Returns true
if we are connected to a non-default Akonadi server instance.
- Since
- 4.10
Definition at line 289 of file servermanager.cpp.
◆ instanceIdentifier()
|
static |
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
Definition at line 284 of file servermanager.cpp.
◆ isRunning()
|
static |
Checks if the server is available currently.
For more detailed status information see state().
- See also
- state()
Definition at line 221 of file servermanager.cpp.
◆ self()
|
static |
Returns the singleton instance of this class, for connecting to its signals.
Definition at line 161 of file servermanager.cpp.
◆ serviceName()
|
static |
Returns the namespaced D-Bus service name for serviceType
.
Use this rather the raw service name strings in order to support usage of a non-default instance of the Akonadi server.
- Parameters
-
serviceType the service type for which to return the D-Bus name
- Since
- 4.10
Definition at line 307 of file servermanager.cpp.
◆ showSelfTestDialog()
|
static |
Shows the Akonadi self test dialog, which tests Akonadi for various problems and reports these to the user if.
- Parameters
-
parent the parent widget for the dialog
Definition at line 213 of file servermanager.cpp.
◆ start()
|
static |
Starts the server.
This method returns imediately and does not wait until the server is actually up and running.
- Returns
true
if the start was possible (which not necessarily means the server is really running though) andfalse
if an immediate error occurred.
- See also
- Akonadi::Control::start()
Definition at line 166 of file servermanager.cpp.
◆ started
|
signal |
Emitted whenever the server becomes fully operational.
◆ state()
|
static |
◆ stateChanged
|
signal |
Emitted whenever the server state changes.
- Parameters
-
state the new server state
- Since
- 4.5
◆ stop()
|
static |
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.
- Returns
true
if the shutdown command was sent successfully,false
otherwise
Definition at line 200 of file servermanager.cpp.
◆ stopped
|
signal |
Emitted whenever the server becomes unavailable.
The documentation for this class was generated from the following files:
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.