Buteo Synchronization Framework
Public Member Functions | List of all members
Buteo::ClientPluginRunner Class Reference

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

#include <ClientPluginRunner.h>

Inheritance diagram for Buteo::ClientPluginRunner:
Buteo::PluginRunner

Public Member Functions

 ClientPluginRunner (const QString &aPluginName, SyncProfile *aProfile, PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf, QObject *aParent=0)
 Constructor.
 
virtual ~ClientPluginRunner ()
 Destructor.
 
virtual bool init ()
 
virtual bool start ()
 
virtual void stop ()
 
virtual void abort (Sync::SyncStatus aStatus=Sync::SYNC_ABORTED)
 
virtual SyncResults syncResults ()
 
virtual SyncPluginBaseplugin ()
 
virtual bool cleanUp ()
 
- Public Member Functions inherited from Buteo::PluginRunner
 PluginRunner (PluginType aPluginType, const QString &aPluginName, PluginManager *aPluginMgr, PluginCbInterface *aPluginCbIf, QObject *aParent=0)
 Constructor.
 
virtual bool init ()=0
 Initializes the plug-in runner.
 
virtual bool start ()=0
 Starts running the plug-in.
 
virtual void stop ()=0
 Stops running the plug-in.
 
virtual void abort (Sync::SyncStatus aStatus=Sync::SYNC_ABORTED)=0
 Aborts running the plug-in.
 
virtual SyncResults syncResults ()=0
 Gets the sync results from the plug-in.
 
virtual bool cleanUp ()=0
 Calls the cleanup for the plugin.
 
PluginType pluginType () const
 Gets the plug-in type.
 
QString pluginName () const
 Gets the plug-in name.
 
virtual SyncPluginBaseplugin ()=0
 Gets the plug-in associated with this plug-in runner.
 

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.
 
PluginManageriPluginMgr
 pointer to an instance of plugin manager
 
PluginCbInterfaceiPluginCbIf
 pointer to an instance of synchronizer
 
PluginType iType
 type of the plugin
 
QString iPluginName
 name of the plugin
 

Detailed Description

Class for running client sync plug-ins.

Constructor & Destructor Documentation

◆ ClientPluginRunner()

ClientPluginRunner::ClientPluginRunner ( const QString &  aPluginName,
SyncProfile aProfile,
PluginManager aPluginMgr,
PluginCbInterface aPluginCbIf,
QObject *  aParent = 0 
)

Constructor.

Parameters
aPluginNameName of the plug-in to run
aProfileSync profile for the client plug-in. Ownership is NOT transferred.
aPluginMgrPluginManager instance for creating and destroying plug-ins by name
aPluginCbIfCallback interface that the created plug-in can use
aParentParent object

Member Function Documentation

◆ abort()

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

◆ cleanUp()

bool ClientPluginRunner::cleanUp ( )
virtual

◆ init()

bool ClientPluginRunner::init ( )
virtual

◆ plugin()

SyncPluginBase * ClientPluginRunner::plugin ( )
virtual

◆ start()

bool ClientPluginRunner::start ( )
virtual

◆ stop()

void ClientPluginRunner::stop ( )
virtual

◆ syncResults()

SyncResults ClientPluginRunner::syncResults ( )
virtual

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