objectCM.h

/* Copyright (c) 2007-2009, Stefan Eilemann <eile@equalizergraphics.com> 
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *  
 * This library 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 Lesser General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQNET_OBJECTCM_H
#define EQNET_OBJECTCM_H

#include <eq/net/dispatcher.h>   // base class
#include <eq/net/types.h>

namespace eq
{
namespace net
{
    class Node;
    class Object;

    class ObjectCM : public Dispatcher
    {
    public:
        ObjectCM() {}
        virtual ~ObjectCM() {}

        virtual void makeThreadSafe() = 0;

        virtual uint32_t commitNB() = 0;
        
        virtual uint32_t commitSync( const uint32_t commitID ) = 0;

        virtual void obsolete( const uint32_t version ) = 0;

        virtual void setAutoObsolete( const uint32_t count,
                                      const uint32_t flags ) = 0;
 
        virtual uint32_t getAutoObsoleteCount() const = 0;

        virtual uint32_t sync( const uint32_t version ) = 0;

        virtual uint32_t getHeadVersion() const = 0;

        virtual uint32_t getVersion() const = 0;

        virtual uint32_t getOldestVersion() const = 0;

        virtual bool isMaster() const = 0;

        virtual uint32_t getMasterInstanceID() const = 0;

        virtual void addSlave( NodePtr node, const uint32_t instanceID,
                               const uint32_t version ) = 0;

        virtual void removeSlave( NodePtr node ) = 0;

        virtual void applyMapData() = 0;

        virtual void addOldMaster( NodePtr node, const uint32_t instanceID ) =0;

        static ObjectCM* ZERO;
    };
}
}

#endif // EQNET_OBJECTCM_H