OpenAB  1.0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
OpenAB_Sync::Sync::SyncCallback Class Referenceabstract

Virtual class that provide all the callback routines to control the synchronization. More...

#include <Sync.hpp>

Public Member Functions

 SyncCallback ()
 
virtual ~SyncCallback ()
 
virtual void print (const std::string &msg)=0
 Dummy funtion used to provide debug messages from Sync. More...
 
virtual void syncFinished (const enum OpenAB_Sync::Sync::eSync &result)=0
 Informs about end of synchronization. More...
 
virtual void syncProgress (const std::string &phaseName, double progress, unsigned int numProcessedItems)=0
 Informs about progress of synchronization. More...
 
virtual void syncPhaseStarted (const std::string &name)=0
 Informs about start of next synchronization phase. More...
 
virtual void syncPhaseFinished (const std::string &name)=0
 Informs about end of synchronization phase. More...
 
virtual void metadataUpdated (const std::string &)
 Informs that synchronization metadata has been updated. More...
 

Detailed Description

Virtual class that provide all the callback routines to control the synchronization.

Constructor & Destructor Documentation

OpenAB_Sync::Sync::SyncCallback::SyncCallback ( )
inline
virtual OpenAB_Sync::Sync::SyncCallback::~SyncCallback ( )
inlinevirtual

Member Function Documentation

virtual void OpenAB_Sync::Sync::SyncCallback::metadataUpdated ( const std::string &  )
inlinevirtual

Informs that synchronization metadata has been updated.

Parameters
[in]metadatametadata information in JSON format.
virtual void OpenAB_Sync::Sync::SyncCallback::print ( const std::string &  msg)
pure virtual

Dummy funtion used to provide debug messages from Sync.

Parameters
[in]msgdebug message
virtual void OpenAB_Sync::Sync::SyncCallback::syncFinished ( const enum OpenAB_Sync::Sync::eSync result)
pure virtual

Informs about end of synchronization.

Parameters
[in]resultresult of synchronization
virtual void OpenAB_Sync::Sync::SyncCallback::syncPhaseFinished ( const std::string &  name)
pure virtual

Informs about end of synchronization phase.

Parameters
[in]namename of phase.
virtual void OpenAB_Sync::Sync::SyncCallback::syncPhaseStarted ( const std::string &  name)
pure virtual

Informs about start of next synchronization phase.

Parameters
[in]namename of phase.
virtual void OpenAB_Sync::Sync::SyncCallback::syncProgress ( const std::string &  phaseName,
double  progress,
unsigned int  numProcessedItems 
)
pure virtual

Informs about progress of synchronization.

Parameters
[in]phaseNamename of current synchronization phase
[in]progresspercentage progress of whole synchronization process (including all phases).

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