/*****************************************************************************************
 *                                                                                       *
 * OpenSpace                                                                             *
 *                                                                                       *
 * Copyright (c) 2014-2023                                                               *
 *                                                                                       *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this  *
 * software and associated documentation files (the "Software"), to deal in the Software *
 * without restriction, including without limitation the rights to use, copy, modify,    *
 * merge, publish, distribute, sublicense, and/or sell copies of the Software, and to    *
 * permit persons to whom the Software is furnished to do so, subject to the following   *
 * conditions:                                                                           *
 *                                                                                       *
 * The above copyright notice and this permission notice shall be included in all copies *
 * or substantial portions of the Software.                                              *
 *                                                                                       *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,   *
 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A         *
 * PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT    *
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF  *
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE  *
 * OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.                                         *
 ****************************************************************************************/

#ifndef __OPENSPACE_CORE___SYNCABLE___H__
#define __OPENSPACE_CORE___SYNCABLE___H__

namespace openspace {

class SyncBuffer;

/**
 * Interface for synchronizable data
 *
 * Used by `SyncEngine`
 */
class Syncable {
public:
    virtual ~Syncable() = default;

protected:
    // Allowing SyncEngine synchronization methods and at the same time hiding them
    // from the used of implementations of the interface
    friend class SyncEngine;

    virtual void preSync(bool /*isMaster*/) {}
    virtual void encode(SyncBuffer* /*syncBuffer*/) = 0;
    virtual void decode(SyncBuffer* /*syncBuffer*/) = 0;
    virtual void postSync(bool /*isMaster*/) {}
};

} // namespace openspace

#endif // __OPENSPACE_CORE___SYNCABLE___H__
