Buteo Synchronization Framework
ClientPluginRunner.h
1/*
2 * This file is part of buteo-syncfw package
3 *
4 * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
5 *
6 * Contact: Sateesh Kavuri <sateesh.kavuri@nokia.com>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public License
10 * version 2.1 as published by the Free Software Foundation.
11 *
12 * This library is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20 * 02110-1301 USA
21 *
22 */
23
24#ifndef CLIENTPLUGINRUNNER_H
25#define CLIENTPLUGINRUNNER_H
26
27#include "PluginRunner.h"
28#include <QProcess>
29
30namespace Buteo {
31
32class ClientPlugin;
33class ClientThread;
34class SyncProfile;
35
39{
40 Q_OBJECT
41
42public:
53 ClientPluginRunner(const QString &aPluginName, SyncProfile *aProfile,
54 PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf,
55 QObject *aParent = 0);
56
58 virtual ~ClientPluginRunner();
59
61 virtual bool init();
62
64 virtual bool start();
65
67 virtual void stop();
68
70 virtual void abort(Sync::SyncStatus aStatus = Sync::SYNC_ABORTED);
71
73 virtual SyncResults syncResults();
74
76 virtual SyncPluginBase *plugin();
77
79 virtual bool cleanUp();
80
81private slots:
82 // Slots for catching plug-in signals.
83
84 void onTransferProgress(const QString &aProfileName,
85 Sync::TransferDatabase aDatabase, Sync::TransferType aType,
86 const QString &aMimeType, int aCommittedItems);
87
88 void onError(const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode);
89
90 void onSuccess(const QString &aProfileName, const QString &aMessage);
91
92 void onStorageAccquired(const QString &aMimeType);
93
94 void onSyncProgressDetail(const QString &aProfileName, int aProgressDetail);
95
96 // Slot for observing thread exit
97 void onThreadExit();
98
99 void pluginTimeout();
100
101private:
102 SyncProfile *iProfile;
103 ClientPlugin *iPlugin;
104 ClientThread *iThread;
105
106#ifdef SYNCFW_UNIT_TESTS
107 friend class ClientPluginRunnerTest;
108#endif
109
110};
111
112}
113
114#endif // CLIENTPLUGINRUNNER_H
Class for running client sync plug-ins.
Definition ClientPluginRunner.h:39
virtual void stop()
Definition ClientPluginRunner.cpp:128
virtual void abort(Sync::SyncStatus aStatus=Sync::SYNC_ABORTED)
Definition ClientPluginRunner.cpp:138
virtual SyncPluginBase * plugin()
Definition ClientPluginRunner.cpp:147
virtual ~ClientPluginRunner()
Destructor.
Definition ClientPluginRunner.cpp:46
virtual SyncResults syncResults()
Definition ClientPluginRunner.cpp:154
virtual bool cleanUp()
Definition ClientPluginRunner.cpp:165
virtual bool init()
Definition ClientPluginRunner.cpp:62
virtual bool start()
Definition ClientPluginRunner.cpp:113
Base class for client plugins.
Definition ClientPlugin.h:38
Thread for client plugins.
Definition ClientThread.h:41
Interface which client and server plugins can use to communicate with synchronization daemon.
Definition PluginCbInterface.h:39
Manages plugins.
Definition PluginManager.h:56
Base class for running sync plug-ins.
Definition PluginRunner.h:45
Base class for client and server plugins.
Definition SyncPluginBase.h:46
A top level synchronization profile.
Definition SyncProfile.h:49
Contains information about a completed synchronization session.
Definition SyncResults.h:62
MinorCode
enum value
Definition SyncResults.h:89