akonadi
Akonadi::ServerManager Class Reference
Provides methods to control the Akonadi server process. More...
#include <servermanager.h>
Inherits QObject.
Signals | |
void | started () |
void | stopped () |
Static Public Member Functions | |
static bool | isRunning () |
static ServerManager * | self () |
static void | showSelfTestDialog (QWidget *parent) |
static bool | start () |
static bool | stop () |
Detailed Description
Provides methods to control the Akonadi server process.
Low-level control of the Akonadi server. Usually Akonadi::Control should be preferred over this.
- See also:
- Akonadi::Control
- Since:
- 4.2
Definition at line 41 of file servermanager.h.
Member Function Documentation
bool ServerManager::isRunning | ( | ) | [static] |
Checks if the server is available currently.
Definition at line 137 of file servermanager.cpp.
ServerManager * Akonadi::ServerManager::self | ( | ) | [static] |
Returns the singleton instance of this class, for connecting to its signals.
Definition at line 99 of file servermanager.cpp.
void ServerManager::showSelfTestDialog | ( | QWidget * | parent | ) | [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 130 of file servermanager.cpp.
bool ServerManager::start | ( | ) | [static] |
Starts the server.
This method returns imediately and does not wait until the server is actually up and running. It is not checked if the server is already running.
- Returns:
true
if the start was possible (which not necessarily means the server is really running though) andfalse
if an error occurred.
- See also:
- Akonadi::Control::start()
Definition at line 104 of file servermanager.cpp.
void Akonadi::ServerManager::started | ( | ) | [signal] |
Emitted whenever the server becomes fully operational.
bool ServerManager::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 119 of file servermanager.cpp.
void Akonadi::ServerManager::stopped | ( | ) | [signal] |
Emitted whenever the server becomes unavailable.
The documentation for this class was generated from the following files: