mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 02:42:51 +00:00
141 lines
3.9 KiB
C++
141 lines
3.9 KiB
C++
/*
|
|
Copyright (c) 2007 Volker Krause <vkrause@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Library General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
|
|
License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef AKONADI_SESSION_H
|
|
#define AKONADI_SESSION_H
|
|
|
|
#include "akonadi_export.h"
|
|
#include <QtCore/QObject>
|
|
|
|
class KJob;
|
|
class FakeSession;
|
|
|
|
namespace Akonadi {
|
|
|
|
class Job;
|
|
class SessionPrivate;
|
|
|
|
/**
|
|
* @short 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).
|
|
*
|
|
* @code
|
|
*
|
|
* 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*)) );
|
|
*
|
|
* @endcode
|
|
*
|
|
* @author Volker Krause <vkrause@kde.org>
|
|
*/
|
|
class AKONADI_EXPORT Session : public QObject
|
|
{
|
|
Q_OBJECT
|
|
|
|
friend class Job;
|
|
friend class JobPrivate;
|
|
friend class SessionPrivate;
|
|
|
|
public:
|
|
/**
|
|
* Creates a new session.
|
|
*
|
|
* @param sessionId The identifier for this session, will be a
|
|
* random value if empty.
|
|
* @param parent The parent object.
|
|
*
|
|
* @see defaultSession()
|
|
*/
|
|
explicit Session(const QByteArray &sessionId = QByteArray(), QObject *parent = 0);
|
|
|
|
/**
|
|
* Destroys the session.
|
|
*/
|
|
~Session();
|
|
|
|
/**
|
|
* Returns the session identifier.
|
|
*/
|
|
QByteArray sessionId() const;
|
|
|
|
/**
|
|
* Returns the default session for this thread.
|
|
*/
|
|
static Session *defaultSession();
|
|
|
|
/**
|
|
* Stops all jobs queued for execution.
|
|
*/
|
|
void clear();
|
|
|
|
Q_SIGNALS:
|
|
/**
|
|
* This signal is emitted whenever the session has been reconnected
|
|
* to the server (e.g. after a server crash).
|
|
*
|
|
* @since 4.6
|
|
*/
|
|
void reconnected();
|
|
|
|
protected:
|
|
/**
|
|
* Creates a new session with shared private object.
|
|
*
|
|
* @param d The private object.
|
|
* @param sessionId The identifier for this session, will be a
|
|
* random value if empty.
|
|
* @param parent The parent object.
|
|
*
|
|
* @note This constructor is needed for unit testing only.
|
|
*/
|
|
explicit Session(SessionPrivate *d, const QByteArray &sessionId = QByteArray(), QObject *parent = 0);
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
SessionPrivate *const d;
|
|
friend class ::FakeSession;
|
|
|
|
Q_PRIVATE_SLOT(d, void reconnect())
|
|
Q_PRIVATE_SLOT(d, void socketError(QLocalSocket::LocalSocketError))
|
|
Q_PRIVATE_SLOT(d, void socketError(QAbstractSocket::SocketError))
|
|
Q_PRIVATE_SLOT(d, void socketDisconnected())
|
|
Q_PRIVATE_SLOT(d, void dataReceived())
|
|
Q_PRIVATE_SLOT(d, void doStartNext())
|
|
Q_PRIVATE_SLOT(d, void jobDone(KJob *))
|
|
Q_PRIVATE_SLOT(d, void jobWriteFinished(Akonadi::Job *))
|
|
Q_PRIVATE_SLOT(d, void jobDestroyed(QObject *))
|
|
Q_PRIVATE_SLOT(d, void serverStateChanged(Akonadi::ServerManager::State))
|
|
//@endcond PRIVATE
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|