Akonadi::ServerManager Class Reference

#include <servermanager.h>

Inheritance diagram for Akonadi::ServerManager:

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 ()
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)

Additional Inherited Members
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const QObject *receiver, const char *method)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

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 337 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 323 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 289 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 284 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 221 of file servermanager.cpp.

ServerManager * Akonadi::ServerManager::self ( )

static

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

Definition at line 161 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 307 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 213 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 166 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 226 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 200 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