kitchensync
KSync::Syncer Class Reference
#include <syncer.h>
Detailed Description
This class provides syncing of sets of data entries.
- Author:
- Cornelius Schumacher, zecke
To perform a syncing process you have to create objects of the concrete subclasses of Syncee, representing the type of the data to be synced. They are added to Syncer with the function addSyncee(). When all data sets to be synced are added, call the sync() functions to perform the actual syncing.
For conflict resolution, a user interface is needed. This has to be a subclass of SyncUi and is provided, when constructing a Syncer instance.
Definition at line 55 of file syncer.h.
Public Member Functions | |
Syncer (SyncUi *ui=0, SyncAlgorithm *algorithm=0) | |
virtual | ~Syncer () |
void | setSyncAlgorithm (SyncAlgorithm *) |
void | setSyncUi (SyncUi *) |
void | addSyncee (Syncee *) |
void | clear () |
void | sync () |
void | syncAllToTarget (Syncee *target, bool writeback=false) |
void | syncToTarget (Syncee *syncee, Syncee *target, bool override=false) |
Constructor & Destructor Documentation
|
Create a Syncer instance. You have to provide an instance of a conflict resolution user interface, which is used to resolve conflicts in the synced data, which cannot be resolved automatically. The UI does not necessarily have to be interactive. Definition at line 33 of file syncer.cpp. |
Member Function Documentation
|
Add a data set, which is to be synced.
Definition at line 53 of file syncer.cpp. |
|
Removes all Syncee objects added with addSyncee from the Syncer.
Definition at line 58 of file syncer.cpp. |
|
Sets the syncing algorithm which is used to perform the sync.
Definition at line 108 of file syncer.cpp. |
|
Sets user interface handler which is used for resolving conflicts.
Definition at line 115 of file syncer.cpp. |
|
Sync all data sets. After execution of this functions all data sets, which have been added to Syncer contain the same set of data. This function might call conflict resolution functions of the SyncUi object. Definition at line 63 of file syncer.cpp. |
|
Sync all data sets with a target data sets. After execution of this function the target Syncee data set contains a combination of all data sets added to Syncer. The added data sets are not changed. This function might call conflict resolution functions of the SyncUi object. Definition at line 86 of file syncer.cpp. |
|
Sync one specific data set to a target data set. After execution of this function the target contains the combination of the two data sets. Only the target is changed. This function might call conflict resolution functions of the SyncUi object. Definition at line 103 of file syncer.cpp. |
The documentation for this class was generated from the following files: