src/include/common/client/SyncClient.h

00001 /*
00002  * Funambol is a mobile platform developed by Funambol, Inc. 
00003  * Copyright (C) 2003 - 2007 Funambol, Inc.
00004  * 
00005  * This program is free software; you can redistribute it and/or modify it under
00006  * the terms of the GNU Affero General Public License version 3 as published by
00007  * the Free Software Foundation with the addition of the following permission 
00008  * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
00009  * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
00010  * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
00011  * 
00012  * This program is distributed in the hope that it will be useful, but WITHOUT
00013  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00014  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
00015  * details.
00016  * 
00017  * You should have received a copy of the GNU Affero General Public License 
00018  * along with this program; if not, see http://www.gnu.org/licenses or write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
00020  * MA 02110-1301 USA.
00021  * 
00022  * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
00023  * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
00024  * 
00025  * The interactive user interfaces in modified source and object code versions
00026  * of this program must display Appropriate Legal Notices, as required under
00027  * Section 5 of the GNU Affero General Public License version 3.
00028  * 
00029  * In accordance with Section 7(b) of the GNU Affero General Public License
00030  * version 3, these Appropriate Legal Notices must retain the display of the
00031  * "Powered by Funambol" logo. If the display of the logo is not reasonably 
00032  * feasible for technical reasons, the Appropriate Legal Notices must display
00033  * the words "Powered by Funambol".
00034  */
00035 
00036 #ifndef INCL_SYNCCLIENT
00037     #define INCL_SYNCCLIENT
00038 
00042     #include "base/fscapi.h"
00043     #include "base/Log.h"
00044     #include "spds/SyncManagerConfig.h"
00045     #include "spds/SyncSource.h"
00046     #include "spds/constants.h"
00047     #include "spds/SyncReport.h"
00048 
00061     class SyncClient {
00062       public:
00063 
00064         SyncClient();
00065         virtual ~SyncClient();
00066 
00067         /*
00068          * Execute a synchronization on the specified sources.
00069          * The sources will be configured automatically using the
00070          * client configuration set in the constructor.
00071          *
00072          * @param config  - the configuration to be used for this sync
00073          * @param sources - NULL terminated array of sources to sync.
00074          *
00075          * @return - 0 on success, an error otherwise
00076          */
00077         virtual int sync(SyncManagerConfig& config, SyncSource** sources);
00078 
00102         virtual int sync(SyncManagerConfig& config, char** sourceNames = NULL);
00103 
00104         /*
00105          * Returns a pointer to the internal syncReport.
00106          * Used to get detailed results on the executed synchronization.
00107          * Must be called after sync() method.
00108          */
00109         SyncReport* getSyncReport();
00110 
00111 
00112       protected:
00123         virtual int prepareSync(SyncManagerConfig& config) {
00124             return ERR_NONE;
00125         }
00126 
00148         virtual int createSyncSource(const char *name, const int pos,
00149                                      SyncSourceConfig* config,
00150                                      SyncSource **source) {
00151             *source = NULL;
00152             return ERR_UNSPECIFIED;
00153         }
00154 
00160         virtual int beginSync(SyncSource **source) {
00161             return ERR_NONE;
00162         }
00163 
00168         virtual int endSync(SyncSource **source) {
00169             return ERR_NONE;
00170         }
00171 
00177         virtual int continueAfterPrepareSync() {
00178             return ERR_NONE;
00179         }
00180 
00185         virtual int continueAfterSync() {
00186             return ERR_NONE;
00187         }
00188 
00189         // The report of the synchronization process.
00190         // Sources reports are initializated during sync(sources**) call.
00191         SyncReport syncReport;
00192     };
00193 
00196 #endif
00197 

Generated on Thu Mar 6 14:25:04 2008 for Funambol C++ Client Library by  doxygen 1.5.2