Base class for server plugins.
More...
#include <ServerPlugin.h>
|
void | newSession (const QString &aDestination) |
| Signal sent when a new sync session is received by the server.
|
|
void | transferProgress (const QString &aProfileName, Sync::TransferDatabase aDatabase, Sync::TransferType aType, const QString &aMimeType, int aCommittedItems) |
| Emitted when progress has been made in synchronization in transferring items between local and remote database.
|
|
void | error (const QString &aProfileName, const QString &aMessage, SyncResults::MinorCode aErrorCode) |
| Emitted when error has occurred in synchronization and it cannot be continued.
|
|
void | success (const QString &aProfileName, const QString &aMessage) |
| Emitted when synchronization has been finished successfully.
|
|
void | accquiredStorage (const QString &aMimeType) |
| Emitted when a storage is requested and accquired.
|
|
void | syncProgressDetail (const QString &aProfileName, int aProgressDetail) |
| Emitted during Sync Progress to indicate the detail of the current ongoing sync.
|
|
|
| ServerPlugin (const QString &aPluginName, const Profile &aProfile, PluginCbInterface *aCbInterface) |
| Constructor.
|
|
virtual | ~ServerPlugin () |
| Destructor.
|
|
virtual bool | startListen ()=0 |
| Start listening for sync requests.
|
|
virtual void | stopListen ()=0 |
| Stop listening for sync requests.
|
|
virtual void | suspend ()=0 |
| Suspend activity.
|
|
virtual void | resume ()=0 |
| Resume suspended activity.
|
|
| SyncPluginBase (const QString &aPluginName, const QString &aProfileName, PluginCbInterface *aCbInterface) |
| Constructor.
|
|
QString | getPluginName () const |
| Returns the name of this plugin.
|
|
QString | getProfileName () const |
| Returns profile name.
|
|
virtual bool | init ()=0 |
| Initializes the plugin.
|
|
virtual bool | uninit ()=0 |
| Uninitializes the plugin.
|
|
virtual void | abortSync (Sync::SyncStatus aStatus=Sync::SYNC_ABORTED) |
| Aborts synchronization.
|
|
virtual bool | cleanUp ()=0 |
| Cleans up any sync related stuff (e.g sync anchors etc) when the profile is deleted.
|
|
virtual SyncResults | getSyncResults () const |
| Gets the results of the last completed sync session.
|
|
|
virtual void | connectivityStateChanged (Sync::ConnectivityType aType, bool aState)=0 |
| Slot that is invoked by sync framework when changes occur in connectivity domains.
|
|
Base class for server plugins.
◆ ServerPlugin()
Constructor.
- Parameters
-
aPluginName | Name of this plugin |
aProfile | Server profile |
aCbInterface | Pointer to the callback interface |
◆ newSession
void Buteo::ServerPlugin::newSession |
( |
const QString & |
aDestination | ) |
|
|
signal |
Signal sent when a new sync session is received by the server.
- Parameters
-
aDestination | Sync destination address, for example BT address or URL. |
◆ resume()
virtual void Buteo::ServerPlugin::resume |
( |
| ) |
|
|
pure virtual |
◆ startListen()
virtual bool Buteo::ServerPlugin::startListen |
( |
| ) |
|
|
pure virtual |
Start listening for sync requests.
Init must me called before this function.
- Returns
- True on success, otherwise false
Implemented in Buteo::OOPServerPlugin.
◆ stopListen()
virtual void Buteo::ServerPlugin::stopListen |
( |
| ) |
|
|
pure virtual |
◆ suspend()
virtual void Buteo::ServerPlugin::suspend |
( |
| ) |
|
|
pure virtual |
Suspend activity.
Implement this if upon being asked to suspend for some reason, any ongoing activity can be suspended
Implemented in Buteo::OOPServerPlugin.
The documentation for this class was generated from the following files: