Buteo Synchronization Framework
Buteo::ServerPluginRunner Class Reference

Class for running server sync plug-ins. More...

#include <ServerPluginRunner.h>

Inheritance diagram for Buteo::ServerPluginRunner:
Buteo::PluginRunner

Public Member Functions

 ServerPluginRunner (const QString &aPluginName, Profile *aProfile, PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf, ServerActivator *aServerActivator, QObject *aParent=0)
 Constructor.
virtual ~ServerPluginRunner ()
 Destructor.
virtual bool init ()
virtual bool start ()
virtual void stop ()
virtual void abort (Sync::SyncStatus aStatus=Sync::SYNC_ABORTED)
virtual SyncResults syncResults ()
virtual SyncPluginBase * plugin ()
virtual bool cleanUp ()
void suspend ()
void resume ()
Public Member Functions inherited from Buteo::PluginRunner
 PluginRunner (PluginType aPluginType, const QString &aPluginName, PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf, QObject *aParent=0)
 Constructor.
PluginType pluginType () const
 Gets the plug-in type.
QString pluginName () const
 Gets the plug-in name.

Additional Inherited Members

Public Types inherited from Buteo::PluginRunner
enum  PluginType { PLUGIN_CLIENT , PLUGIN_SERVER }
 Plug-in type: client or server.
Signals inherited from Buteo::PluginRunner
void transferProgress (const QString &aProfileName, Sync::TransferDatabase aDatabase, Sync::TransferType aType, const QString &aMimeType, int aCommittedItems)
void error (const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode)
void success (const QString &aProfileName, const QString &aMessage)
void storageAccquired (const QString &aMimeType)
void syncProgressDetail (const QString &aProfileName, int aProgressDetail)
void done ()
 Signal sent when the plug-in runner has finished.
void newSession (const QString &aDestination)
void connectivityStateChanged (Sync::ConnectivityType aType, bool aState)
Protected Attributes inherited from Buteo::PluginRunner
bool iInitialized
 Initialization status of the plugin.
PluginManager * iPluginMgr
 pointer to an instance of plugin manager
PluginCbInterface * iPluginCbIf
 pointer to an instance of synchronizer
PluginType iType
 type of the plugin
QString iPluginName
 name of the plugin

Detailed Description

Class for running server sync plug-ins.

Constructor & Destructor Documentation

◆ ServerPluginRunner()

ServerPluginRunner::ServerPluginRunner ( const QString & aPluginName,
Profile * aProfile,
PluginManager * aPluginMgr,
PluginCbInterface * aPluginCbIf,
ServerActivator * aServerActivator,
QObject * aParent = 0 )

Constructor.

Parameters
aPluginNameName of the plug-in to run
aProfileProfile for the server plug-in. Ownership is transferred.
aPluginMgrPluginManager instance for creating and destroying plug-ins by name
aPluginCbIfCallback interface that the created plug-in can use
aServerActivatorServer activator, controls enabled/disabled state of the server plug-in
aParentParent object

Member Function Documentation

◆ abort()

void ServerPluginRunner::abort ( Sync::SyncStatus aStatus = Sync::SYNC_ABORTED)
virtual

◆ cleanUp()

bool ServerPluginRunner::cleanUp ( )
virtual

◆ init()

bool ServerPluginRunner::init ( )
virtual

◆ plugin()

SyncPluginBase * ServerPluginRunner::plugin ( )
virtual

◆ start()

bool ServerPluginRunner::start ( )
virtual

◆ stop()

void ServerPluginRunner::stop ( )
virtual

◆ syncResults()

SyncResults ServerPluginRunner::syncResults ( )
virtual

The documentation for this class was generated from the following files: