core/session.h

/*
    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 "akonadicore_export.h"
#include <QObject>

class KJob;
class FakeSession;
class FakeNotificationConnection;

namespace Akonadi
{
namespace Protocol
{
class Command;
using CommandPtr = QSharedPointer<Command>;
}

class Job;
class SessionPrivate;
class ChangeNotificationDependenciesFactory;

class AKONADICORE_EXPORT Session : public QObject
{
    Q_OBJECT

    friend class Job;
    friend class JobPrivate;
    friend class SessionPrivate;

public:
    explicit Session(const QByteArray &sessionId = QByteArray(), QObject *parent = nullptr);

    ~Session();

    Q_REQUIRED_RESULT QByteArray sessionId() const;

    static Session *defaultSession();

    void clear();

Q_SIGNALS:
    void reconnected();

protected:
    explicit Session(SessionPrivate *d, const QByteArray &sessionId = QByteArray(), QObject *parent = nullptr);

private:
    //@cond PRIVATE
    SessionPrivate *const d;
    friend class ::FakeSession;
    friend class ::FakeNotificationConnection;
    friend class ChangeNotificationDependenciesFactory;

    Q_PRIVATE_SLOT(d, void reconnect())
    Q_PRIVATE_SLOT(d, void socketError(const QString &error))
    Q_PRIVATE_SLOT(d, void socketDisconnected())
    Q_PRIVATE_SLOT(d, bool handleCommands())
    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