gzDistObject.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistObject.h
// Module       : gzDistribution
// Description  : Definition of a gzDistributionObject
// Author       : Christian Andersson   
// Product      : GizmoDistribution 2.1.1
//      
// Copyright © 2004 - Saab Training Systems AB, Sweden
//          
// NOTE:    GizmoDistribution is a toolkit used for implementing distributed 
//          objects and events in C++
//
//
// Revision History...
//                                  
// Who  Date    Description
//                                  
// CAN  031021  Created file
//
//*****************************************************************************
#ifndef __GZ_DIST_OBJECT_H__
#define __GZ_DIST_OBJECT_H__

// Includes
#include "gzDistBase.h"
#include "gzDistAttribute.h"


//----------------------------- gzDistObject ----------------------------------

//*****************************************************************************
// Class    : gzDistObject
//                                  
// Purpose  : The base def class of a distribution object
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//
// Who  Date    Description                     
//                                  
// CAN  031021  Created 
//                                  
//*****************************************************************************

class gzDistObject : public gzDistThreadSafeReference
{
    friend class gzDistManager;
    friend class gzDistSession;
    friend class gzDistObjectAttribute;
    friend class gzDistObjectAttributeIterator;
    friend class gzDistSessionObjectIterator;

    public:

        GZ_DECLARE_TYPE_INTERFACE_EXPORT(GZ_DIST_EXPORT);


        GZ_DIST_EXPORT explicit gzDistObject(const gzString& name);

        GZ_DIST_EXPORT gzDistObject(const gzDistObject& object);

        GZ_DIST_EXPORT virtual ~gzDistObject();


        GZ_DIST_EXPORT gzDouble getAttributeNumber(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeNumber(const gzString& attributeName, gzDouble& number) const;


        GZ_DIST_EXPORT gzString getAttributeString(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeString(const gzString& attributeName, gzString& string) const;


        GZ_DIST_EXPORT gzGUID getAttributeGuid(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeGuid(const gzString& attributeName, gzGUID& guid) const;


        GZ_DIST_EXPORT gzBool setAttributeValue(const gzString& attributeName, const gzDynamicType& value);


        GZ_DIST_EXPORT gzDynamicType getAttributeValue(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeValue(const gzString& attributeName, gzDynamicType& value) const;


        GZ_DIST_EXPORT gzBool hasAttribute(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzDistSessionPtr getSession() const;


        GZ_DIST_EXPORT const gzString& getName() const;


        GZ_DIST_EXPORT virtual gzReference* clone() const;


        GZ_DIST_EXPORT gzBool store(gzSerializeAdapter* adapter) const;


        GZ_DIST_EXPORT gzBool restore(gzSerializeAdapter* adapter);

        GZ_DIST_EXPORT gzUInt getNumberOfAttributes() const;


        GZ_DIST_EXPORT gzBool isOwnerOf(const gzString& attributeName, const gzDistClientID& clientID) const;


        GZ_DIST_EXPORT gzDistClientID getOwnerOf(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool setName(const gzString& objectName);

        /*  \return TRUE if the object belong to a session, otherwise FALSE.*/
        GZ_DIST_EXPORT gzBool inSession() const;


        GZ_DIST_EXPORT gzVoid clear();
    
    private:

        // Remove all subscriptions, ownership and ownersip requests.
        // Returns a pointer to a list of attribute that was owned by client. If there wasn't any, the return value is NULL.
        // Note: The list must be destroyed by the caller.
        gzList<gzDistObjectAttribute>* resign(gzDistClientInterface* client);

        // Subscribe on an attribute
        gzBool subscribeAttributeValue(const gzString& attributeName, gzDistClientInterface* client);

        // Unsubscribe on an attribute
        gzBool unsubscribeAttributeValue(const gzString& attributeName, gzDistClientInterface* client);

        // Subscribe on an attribute
        gzBool subscribeNewAttributes(gzDistClientInterface* client);

        // Unsubscribe on an attribute
        gzBool unsubscribeNewAttributes(gzDistClientInterface* client);

        // Removes all subscriptions by client.
        gzVoid removeSubscriptions(gzDistClientInterface* client);

        // Remove all subscriptions, and sets m_session to NULL.
        gzVoid release();

        // Set m_evaluateHash
        gzVoid setEvalHash(const gzUInt hash);

        // Get m_evaluateHash
        const gzUInt getEvalHash() const;

        // Returns a pointer to the attribute whith the given name.
        gzDistObjectAttribute* getAttribute(const gzString& attributeName);

        // Set curent session
        gzVoid setSession(gzDistSession* session);

        // Checks if there is another owner than client.
        // The method returns TRUE if the attribute is "un-owned" or owned by the client, otherwise FALSE.
        gzBool isAllowedToUpdate(const gzString& attributeName, const gzDistClientID& clientId);

        // Returns a list containing all attributes that client is owner of or is requesting ownership of.
        // Note: The list must be destroyed by the caller.
        gzList<gzDistObjectAttribute>* getOwnerAffectedAttributes(gzDistClientInterface* client);

        // Increase m_ownedAttributes by one.
        gzVoid increaseOwners();

        // Decrease m_ownedAttributes by one.
        gzVoid decreaseOwners();

        // Remove attributes from object.
        gzBool removeAttribute(const gzString& attributeName);

        // Add attributes to object.
        gzVoid addAttribute(gzDistObjectAttribute* attribute);

        // Lock the object and its attributes
        gzVoid lock() const;

        // Unlock the object and its attributes
        gzVoid unLock() const;

        gzVoid cleanUpInstance(const gzDistInstanceID& instance);

        // Internal "get session".
        gzDistSession* session() const;

        // Get next object in order.
        gzDistObject* getNext() const;

        // Get previous object in order.
        gzDistObject* getPrevious() const;

        // Set previous object in order.
        gzVoid setPrevious(gzDistObject* parent);

        // Set next object in order.
        gzVoid setNext(gzDistObject* next);

        // Remove the link order.
        gzVoid removeLink();

    // Members:

        // Dictionary containing all attributes.
        mutable gzRefDict<gzString, gzDistObjectAttribute> m_attributes;

        // This list contain clients that are interested in new/removed attributes.
        gzList<gzDistClientInterface> m_subscribers;

        // Mutex for m_attributes and m_session.
        mutable gzMutex m_locker;

        // The name of the object.
        gzString m_name;

        // The session the object is in.
        gzDistSession* m_session;

        // This member tells if the object has been accepted by a session's evaluator. If so, this value is not zero.
        // The value of this member will get the hash value from the name of the session it is evaluated by.
        // The value must match with the session to be accepted to the session.
        gzULong m_evaluateHash;
        
        // This member tells how many of the object's attributes that are owned by any client.
        // The purpose is to quickly se if any attributes are owned by any client.
        gzUInt m_ownedAttributes;

        // This makes it possible to have an order of all objects in a session.
        struct Link
        {
            gzDistObject* prev;
            gzDistObject* next;
        } m_link;
};


//-------------------------- gzDistObjectAttributeIterator --------------------

//*****************************************************************************
// Class    : gzDistObjectAttributeIterator
//                                  
// Purpose  : Iterator for object attributes
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//
// Who  Date    Description                     
//                                  
// CAN  031021  Created 
//                                  
//*****************************************************************************
class gzDistObjectAttributeIterator
{
    public:

        GZ_DIST_EXPORT gzDistObjectAttributeIterator(const gzDistObjectPtr& object);
        

        GZ_DIST_EXPORT ~gzDistObjectAttributeIterator();


        GZ_DIST_EXPORT gzBool operator()();

        GZ_DIST_EXPORT const gzDistAttribute& current();

        GZ_DIST_EXPORT gzVoid reset();

    private:

        const gzDistObjectPtr m_object;
        gzDictIterator<gzString, gzDistObjectAttribute> m_iterator;
        gzDictEntry<gzString, gzDistObjectAttribute>* m_entry;
        
        // Tells if the iterator has locked the object.
        gzBool m_lockedObject;
};


//----------------------------- gzDistTransaction ------------------------------

//*****************************************************************************
// Class    : gzDistTransaction
//                                  
// Purpose  : Transaction class definition
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//
// Who  Date    Description                     
//                                  
// CAN  031021  Created 
//                                  
//*****************************************************************************

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistTransaction, GZ_DIST_EXPORT);


class gzDistTransaction : public gzDistThreadSafeReference GZ_DIST_MEMBASE(gzDistTransaction)
{
    friend class gzDistSession;
    friend class gzDistTransactionIterator;

    public:

        GZ_DIST_MEMBASE_IMP(gzDistTransaction);

        GZ_DIST_MEMBASE_CALL(gzDistTransaction);

        GZ_DIST_EXPORT gzDistTransaction();

        GZ_DIST_EXPORT gzDistTransaction(const gzString& attributeName, const gzDynamicType& value = gzDynamicType());

        GZ_DIST_EXPORT gzDistTransaction(const gzDistTransaction& transaction);
    
        GZ_DIST_EXPORT virtual ~gzDistTransaction();


        GZ_DIST_EXPORT virtual gzReference* clone() const;


        GZ_DIST_EXPORT gzVoid setAttributeValue(const gzString& attributeName, const gzDynamicType& value);


        GZ_DIST_EXPORT gzVoid setAttributeName(const gzString& attributeName);


        GZ_DIST_EXPORT gzBool hasAttribute(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeValue(const gzString& attributeName, gzDynamicType& value) const;


        GZ_DIST_EXPORT const gzDynamicType& getAttributeValue(const gzString& attributeName) const;


        GZ_DIST_EXPORT gzBool getAttributeNumber(const gzString& attributeName, gzDouble& number) const;


        GZ_DIST_EXPORT gzBool getAttributeString(const gzString& attributeName, gzString& string) const;


        GZ_DIST_EXPORT gzBool getAttributeGuid(const gzString& attributeName, gzGUID& guid) const;


        GZ_DIST_EXPORT gzBool removeAttribute(const gzString& attributeName);


        GZ_DIST_EXPORT gzBool verifyAttribute(const gzString& attributeName, const gzDynamicType& value) const;


        GZ_DIST_EXPORT gzBool store(gzSerializeAdapter* adapter);


        GZ_DIST_EXPORT gzBool restore(gzSerializeAdapter* adapter);


        GZ_DIST_EXPORT gzUInt entries() const;


        GZ_DIST_EXPORT gzBool isEditable() const;

        // Internally used by the client interface.
        // After this is called, it's impossible to set more attribute values.
        gzVoid setSent();

    private:

        // Todo: change gzDistAttribute to a transaction specific class (to be "optimized").
        mutable gzDict<gzString, gzDistAttribute> m_transactionData;
    
        gzBool m_sent;
};


class gzDistTransactionIterator
{
    public:
        GZ_DIST_EXPORT gzDistTransactionIterator(const gzDistTransactionPtr& transaction);

        GZ_DIST_EXPORT ~gzDistTransactionIterator();


        GZ_DIST_EXPORT gzBool operator()();

        GZ_DIST_EXPORT const gzDistAttribute& current() const;

        GZ_DIST_EXPORT gzVoid reset();

    private:
        
        gzDictIterator<gzString, gzDistAttribute> m_iterator;
        gzDictEntry<gzString, gzDistAttribute>* m_entry;
};

//  gzDistUnknownObjectType class.
/*  This class is only for internal use.*/
class gzDistUnknownObjectType : public gzDistObject
{
    public:
        
        gzDistUnknownObjectType(const gzString& typeName, const gzString& objectName);
        virtual ~gzDistUnknownObjectType();

        // Overrides gzDistObject::getType() from gzTypeInterface in gzDistObject
        gzType* getType() const;

    private:
        const gzType m_type;
};

#endif

---