#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.

Author: Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

See also: Akonadi::Control

Since: 4.2

Definition at line 42 of file servermanager.h.

Member Enumeration Documentation

enum Akonadi::ServerManager::ServiceAgentType

Known agent types.

Since: 4.10

Definition at line 135 of file servermanager.h.

enum Akonadi::ServerManager::ServiceType

Types of known D-Bus services.

Since: 4.10

Definition at line 115 of file servermanager.h.

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.
Upgrading	Server is performing a database upgrade as part of a new startup.

Definition at line 50 of file servermanager.h.

Member Function Documentation

QString ServerManager::addNamespace ( const QString & string )

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 324 of file servermanager.cpp.

QString ServerManager::agentServiceName	(	ServiceAgentType	agentType,
		const QString &	identifier
	)

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 310 of file servermanager.cpp.

bool ServerManager::hasInstanceIdentifier ( )

static

Returns true if we are connected to a non-default Akonadi server instance.

Since: 4.10

Definition at line 280 of file servermanager.cpp.

QString ServerManager::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 275 of file servermanager.cpp.

bool ServerManager::isRunning ( )

static

Checks if the server is available currently.

For more detailed status information see state().

See also: state()

Definition at line 213 of file servermanager.cpp.

ServerManager * Akonadi::ServerManager::self ( )

static

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

Definition at line 152 of file servermanager.cpp.

QString ServerManager::serviceName ( ServerManager::ServiceType serviceType )

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 298 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 203 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.

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()

Definition at line 157 of file servermanager.cpp.

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 218 of file servermanager.cpp.

void Akonadi::ServerManager::stateChanged ( Akonadi::ServerManager::State state )

signal

Emitted whenever the server state changes.

Parameters

state the new server state

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 190 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:

akonadi

Public Types

Signals

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation

akonadi

kdepimlibs API Reference

Search