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

akonadi

  • Akonadi
  • Session
Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions
Akonadi::Session Class Reference

A communication session with the Akonadi storage. More...

#include <session.h>

Inherits QObject.

List of all members.

Signals

void reconnected ()

Public Member Functions

 Session (const QByteArray &sessionId=QByteArray(), QObject *parent=0)
 ~Session ()
void clear ()
QByteArray sessionId () const

Static Public Member Functions

static Session * defaultSession ()

Protected Member Functions

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

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 <vkrause@kde.org>

Definition at line 58 of file session.h.


Constructor & Destructor Documentation

Akonadi::Session::Session ( const QByteArray &  sessionId = QByteArray(),
QObject *  parent = 0 
) [explicit]

Creates a new session.

Parameters:
sessionIdThe identifier for this session, will be a random value if empty.
parentThe parent object.
See also:
defaultSession()
Session::~Session ( )

Destroys the session.

Definition at line 392 of file session.cpp.

Akonadi::Session::Session ( SessionPrivate *  d,
const QByteArray &  sessionId = QByteArray(),
QObject *  parent = 0 
) [explicit, protected]

Creates a new session with shared private object.

Parameters:
dThe private object.
sessionIdThe identifier for this session, will be a random value if empty.
parentThe parent object.
Note:
This constructor is needed for unit testing only.

Member Function Documentation

void Akonadi::Session::clear ( )

Stops all jobs queued for execution.

Session * Session::defaultSession ( ) [static]

Returns the default session for this thread.

Definition at line 415 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 398 of file session.cpp.


The documentation for this class was generated from the following files:
  • session.h
  • session.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.4
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