File: ServerPluginRunner.h

package info (click to toggle)
buteo-syncfw 0.11.10-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,704 kB
  • sloc: cpp: 18,406; xml: 396; sh: 34; makefile: 20
file content (118 lines) | stat: -rw-r--r-- 3,476 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
/*
 * 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 SERVERPLUGINRUNNER_H
#define SERVERPLUGINRUNNER_H

#include "PluginRunner.h"

namespace Buteo {


class ServerActivator;
class ServerPlugin;
class ServerThread;
class Profile;

/*! \brief Class for running server sync plug-ins
 */
class ServerPluginRunner : public PluginRunner
{
    Q_OBJECT

public:
    /*! \brief Constructor
     *
     * @param aPluginName Name of the plug-in to run
     * @param aProfile Profile for the server plug-in. Ownership is transferred.
     * @param aPluginMgr PluginManager instance for creating and destroying
     *  plug-ins by name
     * @param aPluginCbIf Callback interface that the created plug-in can use
     * @param aServerActivator Server activator, controls enabled/disabled state
     *  of the server plug-in
     * @param aParent Parent object
     */
    ServerPluginRunner(const QString &aPluginName, Profile *aProfile,
                       PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf,
                       ServerActivator *aServerActivator, QObject *aParent = 0);

    //! \brief Destructor
    virtual ~ServerPluginRunner();

    //! @see PluginRunner::init
    virtual bool init();

    //! @see PluginRunner::start
    virtual bool start();

    //! @see PluginRunner::stop
    virtual void stop();

    //! @see PluginRunner::abort
    virtual void abort(Sync::SyncStatus aStatus = Sync::SYNC_ABORTED);

    //! @see PluginRunner::syncResults
    virtual SyncResults syncResults();

    //! @see PluginRunner::plugin
    virtual SyncPluginBase *plugin();

    //! @see PluginRunner::plugin
    virtual bool cleanUp();

    // Suspend a server plug-in
    void suspend();

    // Resume a suspended server plug-in
    void resume();

private slots:
    // Slots for catching plug-in signals.
    void onNewSession(const QString &aDestination);
    void onTransferProgress(const QString &aProfileName,
                            Sync::TransferDatabase aDatabase, Sync::TransferType aType,
                            const QString &aMimeType, int aCommittedItems);
    void onStorageAccquired(const QString &aMimeType );
    void onError(const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode);
    void onSuccess(const QString &aProfileName, const QString &aMessage);

    // Slot for observing thread exit
    void onThreadExit();

private:
    void onSessionDone();

    Profile *iProfile;
    ServerPlugin *iPlugin;
    ServerThread *iThread;
    ServerActivator *iServerActivator;

#ifdef SYNCFW_UNIT_TESTS
    friend class ServerPluginRunnerTest;
#endif

};

}

#endif // SERVERPLUGINRUNNER_H