src/include/common/client/SyncClient.h

/*
 * Copyright (C) 2003-2007 Funambol
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef INCL_SYNCCLIENT
    #define INCL_SYNCCLIENT

    #include "base/fscapi.h"
    #include "base/Log.h"
    #include "spds/SyncManagerConfig.h"
    #include "spds/SyncSource.h"
    #include "spds/constants.h"
    #include "spds/SyncReport.h"

    class SyncClient {
      public:

        SyncClient();
        virtual ~SyncClient();

        /*
         * Execute a synchronization on the specified sources.
         * The sources will be configured automatically using the
         * client configuration set in the constructor.
         *
         * @param config  - the configuration to be used for this sync
         * @param sources - NULL terminated array of sources to sync.
         *
         * @return - 0 on success, an error otherwise
         */
        virtual int sync(SyncManagerConfig& config, SyncSource** sources);

        virtual int sync(SyncManagerConfig& config, char** sourceNames = NULL);

        /*
         * Returns a pointer to the internal syncReport.
         * Used to get detailed results on the executed synchronization.
         * Must be called after sync() method.
         */
        SyncReport* getSyncReport();


      protected:
        virtual int prepareSync(SyncManagerConfig& config) {
            return ERR_NONE;
        }

        virtual int createSyncSource(const char *name, const int pos,
                                     SyncSourceConfig* config,
                                     SyncSource **source) {
            *source = NULL;
            return ERR_UNSPECIFIED;
        }

        virtual int beginSync(SyncSource **source) {
            return ERR_NONE;
        }

        virtual int endSync(SyncSource **source) {
            return ERR_NONE;
        }

        virtual int continueAfterPrepareSync() {
            return ERR_NONE;
        }

        virtual int continueAfterSync() {
            return ERR_NONE;
        }
        
        // The report of the synchronization process.
        // Sources reports are initializated during sync(sources**) call.
        SyncReport syncReport;
    };

#endif

---