• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • Sitemap
  • Contact Us
 

akonadi

Akonadi::ServerManager

Akonadi::ServerManager Class Reference

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

#include <servermanager.h>

Inherits QObject.

List of all members.


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.

Author:
Volker Krause <vkrause@kde.org>
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) and false 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:
  • servermanager.h
  • 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
  • kabc
  • kblog
  • kcal
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  • kldap
  • kmime
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.5.9
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