• Skip to content
  • Skip to link menu
KDE 4.6 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • ServerManager
Public Types | Signals | Static Public Member Functions

Akonadi::ServerManager Class Reference

Provides methods to control the Akonadi server process. More...

#include <servermanager.h>

Inherits QObject.

List of all members.

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.

Author:
Volker Krause <vkrause@kde.org>
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:
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.

Definition at line 50 of file servermanager.h.


Member Function Documentation

bool ServerManager::isRunning ( ) [static]

Checks if the server is available currently.

For more detailed status information see state().

See also:
state()

Definition at line 197 of file servermanager.cpp.

ServerManager * Akonadi::ServerManager::self ( ) [static]

Returns the singleton instance of this class, for connecting to its signals.

Definition at line 35 of file contactcompletionmodel.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:
parentthe parent widget for the dialog

Definition at line 188 of file servermanager.cpp.

static bool Akonadi::ServerManager::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) and false if an immediate error occurred.
See also:
Akonadi::Control::start()
void Akonadi::ServerManager::started ( ) [signal]

Emitted whenever the server becomes fully operational.

ServerManager::State ServerManager::state ( ) [static]

Returns the state of the server.

Since:
4.5

Definition at line 202 of file servermanager.cpp.

void Akonadi::ServerManager::stateChanged ( Akonadi::ServerManager::State  state) [signal]

Emitted whenever the server state changes.

Since:
4.5
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 176 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:
  • servermanager.h
  • contactcompletionmodel.cpp
  • recentcontactscollections.cpp
  • specialmailcollections.cpp
  • pluginloader.cpp
  • resourcesettings.cpp
  • servermanager.cpp

akonadi

Skip menu "akonadi"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.3
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal