Akonadi::Session Class Reference

#include <session.h>

Inheritance diagram for Akonadi::Session:

Signals
void	reconnected ()

Public Member Functions
	Session (const QByteArray &sessionId=QByteArray(), QObject *parent=0)
	~Session ()
void	clear ()
QByteArray	sessionId () const
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

Static Public Member Functions
static Session *	defaultSession ()
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)

Protected Member Functions
	Session (SessionPrivate *d, const QByteArray &sessionId=QByteArray(), QObject *parent=0)
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)

Additional Inherited Members
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

A communication session with the Akonadi storage.

Every Job object has to be associated with a Session. The session is responsible of scheduling its jobs. For now only a simple serial execution is implemented (the IMAP-like protocol to communicate with the storage backend is capable of parallel execution on a single session though).

using namespace Akonadi;

Session *session = new Session( "mySession" );

CollectionFetchJob *job = new CollectionFetchJob( Collection::root(),
                                                  CollectionFetchJob::Recursive,
                                                  session );

connect( job, SIGNAL(result(KJob*)), this, SLOT(slotResult(KJob*)) );

Author

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

Definition at line 59 of file session.h.

Constructor & Destructor Documentation

Session::Session ( const QByteArray &  sessionId = QByteArray(), QObject *  parent = 0  )

explicit

Creates a new session.

Parameters

sessionId	The identifier for this session, will be a random value if empty.
parent	The parent object.

See also

defaultSession()

Definition at line 454 of file session.cpp.

Session::~Session

(

)

Destroys the session.

Definition at line 468 of file session.cpp.

Session::Session ( SessionPrivate *  d, const QByteArray &  sessionId = QByteArray(), QObject *  parent = 0  )

explicitprotected

Creates a new session with shared private object.

Parameters

d	The private object.
sessionId	The identifier for this session, will be a random value if empty.
parent	The parent object.

Note

This constructor is needed for unit testing only.

Definition at line 461 of file session.cpp.

Member Function Documentation

void Session::clear

(

)

Stops all jobs queued for execution.

Definition at line 504 of file session.cpp.

Session * Session::defaultSession ( )

static

Returns the default session for this thread.

Definition at line 496 of file session.cpp.

void Akonadi::Session::reconnected ( )

signal

This signal is emitted whenever the session has been reconnected to the server (e.g.

after a server crash).

Since

4.6

QByteArray Session::sessionId

(

)

const

Returns the session identifier.

Definition at line 474 of file session.cpp.

---

The documentation for this class was generated from the following files:

• session.h
• session.cpp