SyncManager Class Reference
[Sync Client]

This is the core class which encodes the flow of messages between client and server throughout a session. More...

#include <SyncManager.h>

Collaboration diagram for SyncManager:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 SyncManager (AbstractSyncConfig &config, SyncReport &report)
 Initialize a new sync manager.
int prepareSync (SyncSource **sources)
 Prepares the sync, performing authentication and device capability exchange.
int sync ()
 Starts the synchronization phase.
int endSync ()
 Performs the commit phase of the synchronization.
DevInf * createDeviceInfo ()
 Gathers the various bits and pieces known about the client and its sources and builds a SyncML devinfo 1.2 instance.

Classes

struct  CommandInfo
class  IncomingSyncItem

Detailed Description

This is the core class which encodes the flow of messages between client and server throughout a session.

It is configured via the DMTClientConfig with which it is constructed by the SyncClient::setDMConfig() and the (optional) DevInf provided to it by the client.


Constructor & Destructor Documentation

SyncManager::SyncManager ( AbstractSyncConfig config,
SyncReport report 
)

Initialize a new sync manager.

Parameters provided to it have to remain valid while this sync manager exists.

Parameters:
config required configuration
report sync report reference to store sync results


Member Function Documentation

int SyncManager::sync (  ) 

Starts the synchronization phase.

Returns:
a status code for the sync. Can be: 0 on success an interal code (see: TODO) a status code from the server

DevInf* SyncManager::createDeviceInfo (  ) 

Gathers the various bits and pieces known about the client and its sources and builds a SyncML devinfo 1.2 instance.

For simplicity reasons this function is called for the currently active sync sources, changing them between runs thus causes a (valid!) retransmission of the device info.

Returns:
device infos, to be deleted by caller, or NULL if unavailable


The documentation for this class was generated from the following file:
Generated on Wed Jan 14 17:15:48 2009 for Funambol C++ Client Library by  doxygen 1.5.2