Sync Client

The "common/client" directory contains classes related to writing sync clients and some specific client implementations. More...

Classes
class	DMTClientConfig
	This class is an extension of SyncManagerConfig that is DM tree aware; this means that configuration properties are read/stored from/to the DM tree. More...
class	FileSyncSource
	Synchronizes the content of files in a certain directory and the file attributes using a certain XML format. More...
class	RawFileSyncSource
	In contrast to the FileSyncSource this class does not wrap the file content and attributes in an XML format when exchanging it with the server. More...
class	SyncClient
	This class wraps the common operations executed by a typical client. More...
class	SyncManager
	This is the core class which encodes the flow of messages between client and server throughout a session. More...
class	SyncManagerConfig
	This class groups the configuration information needed by the SyncManager. More...
class	SyncReport
	The SyncReport class is used to summarize all results of a single synchronization. More...
class	SyncSource
	This is the main API that a SyncML client developer needs to implement to let the sync engine access the client's data. More...
class	SyncSourceConfig
	This class groups all configuration properties for a SyncSource. More...
class	SyncSourceReport
	SyncSourceReport class rapresents the report of each SyncSource synchronized. More...
class	CheckSyncReport
	This class encapsulates logging and checking of a SyncReport. More...
class	ClientTest
	This is the interface expected by the testing framework for sync clients. More...
Defines
#define	APPLICATION_URI   "Funambol/SyncclientFILE"
#define	LOG_TITLE   "Funambol FILEClient Log"
#define	LOG_PATH   "."
#define	LOG_LEVEL   LOG_LEVEL_DEBUG
#define	SOURCE_NAME   "briefcase"
#define	WSOURCE_NAME   TEXT("briefcase")
#define	DEVICE_ID   "Funambol FILEClient"
#define	SW_VERSION   "1.0"
#define	ERR_FILE_SYSTEM   1
#define	ERR_NO_FILES_TO_SYNC   2
#define	ERR_BAD_FILE_CONTENT   3
#define	DATA_SIZE_TOLERANCE   1.06
#define	CLIENT   "Client"
#define	SERVER   "Server"
#define	CLIENT_TEST_EQUAL(_prefix, _expected, _actual)
	assert equality, include string in message if unequal
Enumerations
enum	SyncManagerState {   STATE_START = 0, STATE_PKG1_SENDING = 1, STATE_PKG1_SENT = 2, STATE_PKG3_SENDING = 3,   STATE_PKG3_SENT = 4, STATE_PKG5_SENDING = 5, STATE_PKG5_SENT = 6 }
enum	SourceState { SOURCE_ACTIVE = 0, SOURCE_INACTIVE = 1, SOURCE_ERROR = 2 }
	Possible states of syncsource (state member). More...
Functions
void	createConfig (DMTClientConfig &config)

---

Detailed Description

The "common/client" directory contains classes related to writing sync clients and some specific client implementations.

Using these classes is optional. Alternatively one can use the sync engine directly via the SyncManager, but beware that this is more complex.

---

Define Documentation

#define CLIENT_TEST_EQUAL	(	_prefix,
		_expected,
		_actual		)

Value:

CPPUNIT_ASSERT_EQUAL_MESSAGE( std::string(_prefix) + ": " + #_expected + " == " + #_actual, \
                                  _expected, \
                                  _actual )

assert equality, include string in message if unequal

---

Enumeration Type Documentation

enum SourceState

Possible states of syncsource (state member).

Enumerator:

SOURCE_ACTIVE	source is part of the current sync and in a sane state
SOURCE_INACTIVE	source was excluded from the current sync before starting it
SOURCE_ERROR	source encountered and error sometime during the sync

---