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

akonadi

Akonadi::Session

Akonadi::Session Class Reference

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

#include <session.h>

Inherits QObject.

List of all members.


Public Member Functions

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

Static Public Member Functions

static Session * defaultSession ()

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

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 228 of file session.cpp.

Session::~Session (  ) 

Destroys the session.

Definition at line 265 of file session.cpp.


Member Function Documentation

void Session::clear (  ) 

Stops all jobs queued for execution.

Definition at line 295 of file session.cpp.

Session * Session::defaultSession (  )  [static]

Returns the default session for this thread.

Definition at line 288 of file session.cpp.

QByteArray Session::sessionId (  )  const

Returns the session identifier.

Definition at line 271 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
  • 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.8
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