net/object.h

/* Copyright (c) 2005-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_OBJECT_H
#define EQNET_OBJECT_H

#include <eq/net/dispatcher.h>    // base class
#include <eq/net/node.h>          // used in RefPtr
#include <eq/net/types.h>         // for NodeVector

namespace eq
{
namespace net
{
    class DataIStream;
    class DataOStream;
    class Node;
    class ObjectCM;
    class Session;
    struct ObjectPacket;

    class Object : public Dispatcher
    {
    public:
        enum ObsoleteFlags
        {
            AUTO_OBSOLETE_COUNT_VERSIONS = 0,
            AUTO_OBSOLETE_COUNT_COMMITS  = 1
        };

        enum Version
        {
            VERSION_NONE    = 0,
            VERSION_INVALID = 0xfffffffeu,
            VERSION_OLDEST  = VERSION_INVALID,
            VERSION_HEAD    = 0xffffffffu
        };

        enum ChangeType
        {
            STATIC,            
            INSTANCE,          
            DELTA,             
            UNBUFFERED,        
#ifdef EQ_USE_DEPRECATED
            DELTA_UNBUFFERED = UNBUFFERED
#endif
        };

        EQ_EXPORT Object();

        EQ_EXPORT virtual ~Object();

        EQ_EXPORT virtual void attachToSession( const uint32_t id, 
                                                const uint32_t instanceID, 
                                                Session* session );

        EQ_EXPORT virtual void detachFromSession();

        EQ_EXPORT virtual void makeThreadSafe();  
        
        bool isThreadSafe() const      { return _threadSafe; }

        NodePtr getLocalNode();

        const Session* getSession() const { return _session; }

        Session* getSession()             { return _session; }

        uint32_t getID() const         { return _id; }

        uint32_t getInstanceID() const { return _instanceID; }

        EQ_EXPORT bool isMaster() const;

        virtual ChangeType getChangeType() const { return STATIC; }

        void becomeMaster();

        virtual bool isDirty() const { return true; }

        EQ_EXPORT virtual uint32_t commit();

        EQ_EXPORT uint32_t commitNB();
        
        EQ_EXPORT uint32_t commitSync( const uint32_t commitID );

        EQ_EXPORT void obsolete( const uint32_t version );

        EQ_EXPORT void setAutoObsolete( const uint32_t count, 
                          const uint32_t flags = AUTO_OBSOLETE_COUNT_VERSIONS );

        EQ_EXPORT uint32_t getAutoObsoleteCount() const;

        EQ_EXPORT uint32_t sync( const uint32_t version = VERSION_HEAD );

        EQ_EXPORT uint32_t getHeadVersion() const;

        EQ_EXPORT uint32_t getVersion() const;

        EQ_EXPORT uint32_t getOldestVersion() const;

        virtual void notifyNewHeadVersion( const uint32_t version )
            { EQASSERT( getVersion()==VERSION_NONE||version<getVersion()+100 );}

        void setupChangeManager( const Object::ChangeType type, 
                                  const bool master, 
                              const uint32_t masterInstanceID = EQ_ID_INVALID );

    protected:
        EQ_EXPORT Object( const Object& );

        EQ_EXPORT const Object& operator = ( const Object& ) { return *this; }

        virtual void getInstanceData( DataOStream& os ) = 0;

        virtual void applyInstanceData( DataIStream& is ) = 0;

        virtual void pack( DataOStream& os ) { getInstanceData( os ); }

        virtual void unpack( DataIStream& is ) { applyInstanceData( is ); }

        EQ_EXPORT uint32_t getMasterInstanceID() const;

        EQ_EXPORT void addSlave( NodePtr node, const uint32_t instanceID, 
                                 const uint32_t version );

        EQ_EXPORT void removeSlave( NodePtr node );

        bool send( NodePtr node, ObjectPacket& packet );

        bool send( NodePtr node, ObjectPacket& packet,
                   const std::string& string );

        bool send( NodePtr node, ObjectPacket& packet, 
                   const void* data, const uint64_t size );

    private:
        Session*     _session;
        friend class Session;

        friend class DeltaMasterCM;
        friend class DeltaSlaveCM;
        friend class FullMasterCM;
        friend class FullSlaveCM;
        friend class StaticMasterCM;
        friend class StaticSlaveCM;
        friend class UnbufferedMasterCM;

        uint32_t     _id;

        uint32_t     _instanceID;

        ObjectCM* _cm;

        bool _threadSafe;

        void _setChangeManager( ObjectCM* cm );

        /* The command handlers. */
        CommandResult _cmdForward( Command& command );
        CommandResult _cmdNewMaster( Command& command );

        CHECK_THREAD_DECLARE( _thread );
    };
}
}

#endif // EQNET_OBJECT_H