akonadi
#include <servermanager.h>
Inherits QObject.
Public Types | |
enum | State { NotRunning, Starting, Running, Stopping, Broken } |
Signals | |
void | started () |
void | stateChanged (Akonadi::ServerManager::State state) |
void | stopped () |
Static Public Member Functions | |
static bool | isRunning () |
static ServerManager * | self () |
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
enum Akonadi::ServerManager::State |
Enum for the various states the server can be in.
- Since:
- 4.5
- Enumerator:
Definition at line 50 of file servermanager.h.
Member Function Documentation
|
static |
Checks if the server is available currently.
For more detailed status information see state().
- See also:
- state()
Definition at line 201 of file servermanager.cpp.
|
static |
Returns the singleton instance of this class, for connecting to its signals.
Definition at line 145 of file servermanager.cpp.
|
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 192 of file servermanager.cpp.
|
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 150 of file servermanager.cpp.
|
signal |
Emitted whenever the server becomes fully operational.
|
static |
|
signal |
Emitted whenever the server state changes.
- Since:
- 4.5
|
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 180 of file servermanager.cpp.
|
signal |
Emitted whenever the server becomes unavailable.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon Sep 24 2012 09:06:31 by doxygen 1.8.1.1 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.