Client
[Native API]

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

Collaboration diagram for Client:

Classes

class  KeyValueStore
 This is the interface for the handling of key/value pairs. More...
class  MemoryKeyValueStore
 This is the interface for the handling of the key/value that has to be written in the storage. More...
class  PropertyFile
 This is the implementation of the keyValueStore on filesystem. More...
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
 This class extends the CacheSyncSource abstract class, implementing a plain file datastore. More...
class  ODBCKeyValueStore
class  SQLiteKeyValueStore
class  SQLKeyValueStore
 This abstract class represent an implementation of KeyValueStore based on a generic SQL database. More...
class  SyncClient
 This class wraps the common operations executed by a typical client. More...
class  TestFileSyncSource
 Synchronizes the content of files in a certain directory and the file attributes using a certain XML format. More...
class  AbstractSyncConfig
 This class provides access to all attributes of the client and its sources which the sync engine needs to read and (in a few cases) also write. More...
class  AbstractSyncSourceConfig
 This class is the API expected by SyncClient/SyncManager for each sync source. 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 implementation is just a transient configuration information repository; persisting configuration settings is delegated to subclasses. 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 is one possible implementation of the AbstractSyncSourceConfig API: it implements all attributes as read/write members. More...
class  SyncSourceReport
 SyncSourceReport class rapresents the report of each SyncSource synchronized. More...
class  BlockingSQLiteKeyValueStore

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 OMA_MIME_TYPE   "application/vnd.omads-file+xml"
#define DEFAULT_SYNC_DIR   "."
#define DATA_SIZE_TOLERANCE   1.06
#define CLIENT   "Client"
#define SERVER   "Server"

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 APPLICATION_URI   "Funambol/SyncclientFILE"

#define CLIENT   "Client"

#define DATA_SIZE_TOLERANCE   1.06

#define OMA_MIME_TYPE   "application/vnd.omads-file+xml"

Referenced by startSync().


Enumeration Type Documentation

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


Generated on Tue Apr 6 13:00:40 2010 for Funambol Outlook Plug-in Library by  doxygen 1.5.7.1