SyncSession.h

/*
 * This file is part of buteo-syncfw package
 *
 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
 *
 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */
 
#ifndef SYNCSESSION_H
#define SYNCSESSION_H
 
#include "SyncCommonDefs.h"
#include "SyncResults.h"
#include <QObject>
#include <QMap>
 
namespace Buteo {
 
class SyncProfile;
class PluginRunner;
class StorageBooker;
class NetworkManager;
 
class SyncSession : public QObject
{
    Q_OBJECT
 
public:
 
    explicit SyncSession(SyncProfile *aProfile, QObject *aParent = 0);
 
    virtual ~SyncSession();
 
    void setPluginRunner(PluginRunner *aPluginRunner, bool aTransferOwnership);
 
    PluginRunner *pluginRunner();
 
    bool isFinished();
 
    bool isAborted();
 
    bool start();
 
    void abort(Sync::SyncStatus aStatus = Sync::SYNC_ABORTED);
 
    void stop();
 
    SyncProfile *profile() const;
 
    QString profileName() const;
 
    SyncResults results() const;
 
    void setScheduled(bool aScheduled);
 
    bool isScheduled() const;
 
    void updateResults(const SyncResults &aResults);
 
    void setFailureResult(int aMajorCode, int aMinorCode);
 
    bool reserveStorages(StorageBooker *aStorageBooker);
 
    void releaseStorages();
 
    QMap<QString,bool> getStorageMap();
 
    void setStorageMap(QMap<QString,bool> &aStorageMap);
 
    bool isProfileCreated();
 
    void setProfileCreated(bool aProfileCreated);
 
    Sync::SyncStatus mapToSyncStatusError(int aErrorCode);
 
signals:
 
    void transferProgress(const QString &aProfileName,
            Sync::TransferDatabase aDatabase, Sync::TransferType aType,
            const QString &aMimeType, int aCommittedItems);
 
    void storageAccquired (const QString &aProfileName , const QString &aMimeType) ;
 
    void finished(const QString &aProfileName, Sync::SyncStatus aStatus,
            const QString &aMessage, int aErrorCode);
 
    void syncProgressDetail(const QString &aProfileName,int aProgressDetail);
private:
 
    bool tryStart();
 
private slots:
 
    // Slots for catching plug-in runner signals.
 
    void onSuccess(const QString &aProfileName, const QString &aMessage);
 
    void onError(const QString &aProfileName, const QString &aMessage, int aErrorCode);
 
    void onTransferProgress(const QString &aProfileName,
            Sync::TransferDatabase aDatabase, Sync::TransferType aType,
            const QString &aMimeType, int aCommittedItems);
 
    void onStorageAccquired (const QString &aMimeType);
 
    void onSyncProgressDetail(const QString &aProfileName,int aProgressDetail);
 
    void onDone();
 
    void onDestroyed(QObject *aPluginRunner);
 
    void onNetworkSessionOpened();
 
    void onNetworkSessionError();
 
    private:
 
    SyncProfile *iProfile;
 
    PluginRunner *iPluginRunner;
 
    SyncResults iResults;
 
    Sync::SyncStatus iStatus;
 
    int iErrorCode;
 
    bool iPluginRunnerOwned;
 
    bool iScheduled;
 
    bool iAborted;
 
    bool iStarted;
 
    bool iFinished;
 
    bool iCreateProfile;
 
    QString iMessage;
 
    QString iRemoteId ;
 
    StorageBooker *iStorageBooker;
 
    QMap<QString , bool> iStorageMap;
 
    NetworkManager *iNetworkManager;
 
    #ifdef SYNCFW_UNIT_TESTS
    friend class SyncSessionTest;
    #endif
 
};
 
}
 
#endif // SYNCSESSION_H