gzDistNotification.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistNotification.h
// Module       : gzDistribution
// Description  : Declaration of gzDistNotification and gzDistNotificationData
// 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  040121  Created file
//
//*****************************************************************************
#ifndef __GZ_DIST_NOTIFICATION_H__
#define __GZ_DIST_NOTIFICATION_H__

// Includes
#include "gzDistBase.h"


//--------------------------- gzDistNotificationData --------------------------

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistNotificationData, GZ_DIST_EXPORT);


class gzDistNotificationData : public gzDistThreadSafeReference GZ_DIST_MEMBASE(gzDistNotificationData)
{
    friend class gzDistSession;

    public:

        GZ_DIST_MEMBASE_IMP(gzDistNotificationData);

        GZ_DIST_MEMBASE_CALL(gzDistNotificationData);

        GZ_DIST_EXPORT gzDistNotificationData(const gzString& name, const gzDynamicType& data);
    
        GZ_DIST_EXPORT gzDistNotificationData(const class gzDistAttribute* attribute);
    
        GZ_DIST_EXPORT virtual ~gzDistNotificationData();
        
        
        GZ_DIST_EXPORT const gzString& getAttributeName() const;

        GZ_DIST_EXPORT const gzDynamicType& getAttributeValue() const;

        GZ_DIST_EXPORT const gzString& getAttributeType() const;

        GZ_DIST_EXPORT gzDouble getAttributeNumber() const;

        GZ_DIST_EXPORT gzString getAttributeString() const;

        GZ_DIST_EXPORT gzGUID getAttributeGuid() const;

    private:

        // The name of the attribute
        const gzString m_attributeName;

        // The attribute data.
        const gzDynamicType m_attributeValue;
};

//--------------------------- gzDistNotificationSet ------------------------------


class gzDistNotificationSet
{
    friend class gzDistNotificationSetIterator;
    friend class gzDistSession;
    friend class gzDistClientInterface;

    public:
        GZ_DIST_EXPORT gzDistNotificationSet();

        GZ_DIST_EXPORT ~gzDistNotificationSet();

        GZ_DIST_EXPORT gzULong entries() const;

        GZ_DIST_EXPORT gzDistNotificationData* find(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 getAttributeValue(const gzString& attributeName, gzDynamicType& value) const;
    
    private:

        gzVoid insert(gzDistNotificationData* data);
        gzDistNotificationData* first() const;

        gzRefList<gzDistNotificationData> m_data;
};

//--------------------------- gzDistNotificationSetIterator ------------------------------
class gzDistNotificationSetIterator
{
    public:

        GZ_DIST_EXPORT gzDistNotificationSetIterator(const gzDistNotificationSet& list);

        GZ_DIST_EXPORT ~gzDistNotificationSetIterator();


        GZ_DIST_EXPORT gzDistNotificationData* operator()();

        /*  \return A pointer to the gzDistNotificationData at current iterator position*/
        GZ_DIST_EXPORT gzDistNotificationData* current() const;
    
    private:

        gzListConstIterator<gzDistNotificationData> m_iterator;
};

//--------------------------- gzDistNotification ------------------------------

// Notification types
enum gzDistNotificationType
{
    GZ_DIST_NOTIFICATION_TYPE_UNDEFINED = 0,
    GZ_DIST_NOTIFICATION_TYPE_EVENT,
    GZ_DIST_NOTIFICATION_TYPE_NEW_OBJECT,
    GZ_DIST_NOTIFICATION_TYPE_REMOVE_OBJECT,
    GZ_DIST_NOTIFICATION_TYPE_UPDATE_OBJECT,
    GZ_DIST_NOTIFICATION_TYPE_NEW_ATTRIBUTES,
    GZ_DIST_NOTIFICATION_TYPE_REMOVE_ATTRIBUTES,
    GZ_DIST_NOTIFICATION_TYPE_REQUEST_OWNERSHIP,
    GZ_DIST_NOTIFICATION_TYPE_GRANT_OWNERSHIP,
    GZ_DIST_NOTIFICATION_TYPE_DROP_OWNERSHIP,
    GZ_DIST_NOTIFICATION_TYPE_NEW_SESSION,
    GZ_DIST_NOTIFICATION_TYPE_REMOVE_SESSION,
    GZ_DIST_NOTIFICATION_TYPE_UNINITIALIZE_CLIENT,
    GZ_DIST_NOTIFICATION_TYPE_DEBUG,                // Used for debugging only (gzDistMonitor).
    GZ_DIST_NOTIFICATION_TYPE_INVOKE
};

GZ_DIST_DECLARE_MEMBASE(gzDistNotification);

// This is the internal class all clients are notified with from the kernel.
class gzDistNotification : public gzDistThreadSafeReference GZ_DIST_MEMBASE(gzDistNotification)
{
    public:
        GZ_DIST_MEMBASE_IMP(gzDistNotification);

        GZ_DIST_MEMBASE_CALL(gzDistNotification);

        // Default constructor.
        gzDistNotification();

        // Constructor.
        gzDistNotification(gzDistNotificationType type, gzDistThreadSafeReference* reference);

        // Destructor.
        virtual ~gzDistNotification();

        // Set ID in notification.
        gzVoid setClientID(const gzDistClientID& clientId);

        // Get ID from notificaion.
        gzDistClientID* getClientID() const;

        // Set object to notification.
        gzVoid setObject(gzDistObject* object);

        // Get object from notification.
        gzDistObject* getObject() const;

        // Set session to notification.
        gzVoid setSession(gzDistSession* session);

        // Get session from notification.
        gzDistSession* getSession() const;

        // Set event to notification.
        gzVoid setEvent(gzDistEvent* event);

        // Get event from notification.
        gzDistEvent* getEvent() const;

        // Set notification type.
        gzVoid setNotificationType(gzDistNotificationType type);

        // Get notification type.
        gzDistNotificationType getNotificationType() const;

        // The attributes and its data the notification concern. This is used only in a transaction.
        gzDistNotificationSet* m_notification_data;

        // Give the notification high priority.
        gzVoid setHighPrio();

        // return TRUE if the notification has high priority, otherwise FALSE.
        gzBool isHighPrio();

        // Get invoke data
        gzDistThreadSafeReference* getInvokeData() const;

    private:

        // The type of notification
        gzDistNotificationType m_type;

        // A reference to an object or event.
        gzRefPointer<gzDistThreadSafeReference> m_reference;

        // Additional reference to a session etc.
        gzRefPointer<gzDistThreadSafeReference> m_addReference;

        // The ID of the source.
        gzDistClientID* m_clientID;

        // High priority notification.
        gzBool m_highPrio;
};

#endif

---