Buteo Synchronization Framework: ClientPlugin.h Source File

Buteo Synchronization Framework

ClientPlugin.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#ifndef CLIENTPLUGIN_H
24#define CLIENTPLUGIN_H
25
26#include "SyncPluginBase.h"
27#include "SyncProfile.h"
28#include <QMetaType>
29
30namespace Buteo {
31
32class PluginCbInterface;
33
37 class ClientPlugin : public SyncPluginBase
38{
39 Q_OBJECT
40
41public:
42
49 ClientPlugin(const QString &aPluginName,
50 const SyncProfile &aProfile,
51 PluginCbInterface *aCbInterface);
52
57 virtual ~ClientPlugin();
58
64 virtual bool startSync() = 0;
65
68 SyncProfile &profile()
69 {
70 return iProfile;
71 }
72
73protected:
75 SyncProfile iProfile;
76};
77
78}
79
80#endif // CLIENTPLUGIN_H
Buteo::ClientPlugin
Base class for client plugins.
Definition: ClientPlugin.h:38
Buteo::ClientPlugin::startSync
virtual bool startSync()=0
Starts synchronization.
Buteo::ClientPlugin::ClientPlugin
ClientPlugin(const QString &aPluginName, const SyncProfile &aProfile, PluginCbInterface *aCbInterface)
Constructor.
Definition: ClientPlugin.cpp:27
Buteo::ClientPlugin::profile
SyncProfile & profile()
access to profile owned and used by this instance
Definition: ClientPlugin.h:68
Buteo::ClientPlugin::iProfile
SyncProfile iProfile
Sync Profile Object that the plugin is currently operating on.
Definition: ClientPlugin.h:75
Buteo::ClientPlugin::~ClientPlugin
virtual ~ClientPlugin()
Destructor.
Definition: ClientPlugin.cpp:35
Buteo::PluginCbInterface
Interface which client and server plugins can use to communicate with synchronization daemon.
Definition: PluginCbInterface.h:39
Buteo::SyncPluginBase
Base class for client and server plugins.
Definition: SyncPluginBase.h:46
Buteo::SyncProfile
A top level synchronization profile.
Definition: SyncProfile.h:49