gzDistDebug.h

//*****************************************************************************
// File         : gzDistDebug.h
// Module       : gzDistribution
// Description  : Definition of gzDistDebugClient
// 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  040610  Created file
//
//*****************************************************************************
#ifndef __GZ_DIST_DEBUG_H__
#define __GZ_DIST_DEBUG_H__

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

// Constants
const gzULong GZ_DIST_DEBUG_BUFFER_SIZE = 0x4000; // 16 KB
const gzULong GZ_DIST_DEBUG_MESSAGE_HEADER_SIZE = 5;
const gzString GZ_DIST_DEBUG_PIPE_NAME = "gz_dist_dbg";
const gzString GZ_DIST_DEBUG_CLIENT_NAME = gzUniqueString("DebugClient", 75);

enum gzDistDebugMessageType
{
    GZ_DIST_DEBUG_MESSAGE_TYPE_ID,
    GZ_DIST_DEBUG_MESSAGE_TYPE_START,
    GZ_DIST_DEBUG_MESSAGE_TYPE_STOP,
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_CLIENT,                          // Initialized clients.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_CLIENT,                      // Clients that do uninitialize.
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_SESSION,                         
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_SESSION,                     
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_SESSION_CLIENT,                  // Joined clients.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_SESSION_CLIENT,              // Clients that do resign session.
    GZ_DIST_DEBUG_MESSAGE_TYPE_EVENT,                               
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_OBJECT,                          
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_OBJECT,                      
    GZ_DIST_DEBUG_MESSAGE_TYPE_OWNERSHIP,                           // Ownership
    GZ_DIST_DEBUG_MESSAGE_TYPE_UPDATE_ATTRIBUTES,                   
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_ATTRIBUTES,                  
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_SESSION_SUBSCRIBER,              // Clients that subscribes new/removed sessions.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_SESSION_SUBSCRIBER,          // Clients that unsubscribes new/removed sessions.
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_EVENT_TYPE_SUBSCRIBER,           // Class type subscription.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_EVENT_TYPE_SUBSCRIBER,       // Class type subscription.
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_OBJECT_TYPE_SUBSCRIBER,          // Class type subscription.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_OBJECT_TYPE_SUBSCRIBER,      // Class type subscription.
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_ATTRIBUTE_SUBSCRIBER,            // Subscription on new/removed attributes in objects.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_ATTRIBUTE_SUBSCRIBER,        // Subscription on new/removed attributes in objects.
    GZ_DIST_DEBUG_MESSAGE_TYPE_NEW_ATTRIBUTE_VALUE_SUBSCRIBER,      // Subscription on attribute value.
    GZ_DIST_DEBUG_MESSAGE_TYPE_REMOVED_ATTRIBUTE_VALUE_SUBSCRIBER,  // Subscription on attribute value.
    GZ_DIST_DEBUG_MESSAGE_TYPE_UNIQUE_STRINGS                       // Unique gzStrings with Ids.
};

//-------------------------- gzDistDebugManagerClient ---------------------------

class gzDistDebugManagerClient : public gzReference
{
    public:
        gzDistDebugManagerClient(const gzDistClientID& id, gzInt poolId) : clientId(id), poolId(poolId) {}
        virtual ~gzDistDebugManagerClient() {}

        gzDistClientID clientId;
        gzInt poolId;
};


//-------------------------- gzDistDebugOwnerData ---------------------------

class gzDistDebugOwnerData : public gzReference
{
    public:
        gzDistDebugOwnerData();
        virtual ~gzDistDebugOwnerData();

        gzString sessionName;
        gzString objectName;
        gzString attributeName;
        gzRefList<gzRefData<gzDistClientID> > ownerData;
};


//-------------------------- gzDistDebugClient ---------------------------

class gzDistDebugClient : public gzDistClientInterface
{
    public:
        gzDistDebugClient();
        virtual ~gzDistDebugClient();

        gzVoid run();
        
    protected:

        gzVoid onClientTick();

        //----- notification callbacks -----
    
        gzVoid onEvent(gzDistEvent* event);
        gzVoid onNewObject(gzDistObject* object, gzDistSession* session);
        gzVoid onRemoveObject(gzDistObject* object, gzDistSession* session);
        gzVoid onUpdateAttributes(const gzDistNotificationSet& attributes, gzDistObject* object, gzDistSession* session);
        gzVoid onNewAttributes(const gzDistNotificationSet& attributes, gzDistObject* object, gzDistSession* session);
        gzVoid onRemoveAttributes(const gzDistNotificationSet& attributes, gzDistObject* object, gzDistSession* session);
        gzVoid onNewSession(gzDistSession* session);
        gzVoid onRemoveSession(gzDistSession* session);
        gzVoid onSystemShutdown();
        gzVoid onDebugMessage(gzDistDebugNotification* notification);

    private:

        gzVoid processDebugMessages();

        gzVoid sendData(gzUByte messageType);

        gzVoid initAdapter();

        gzVoid writeClientId(const gzDistClientID* id);

        gzVoid sendIdentification();

        gzVoid sendManagerClients();

        gzVoid sendUniqueStrings();

    // Members:

        gzPipe m_pipe;
        gzBool m_active;
        gzBool m_run;
        gzSerializeAdapterMemory m_adapter;
        gzUByte* m_memory;

        gzSerializeString m_string;
        gzSerializeBinary<gzBool> m_bool;
        gzSerializeBinary<gzUByte> m_byte;
        gzSerializeBinary<gzUShort> m_ushort;
        gzSerializeBinary<gzULong> m_ulong;
        gzSerializeBinary<gzULong> m_pid;

        gzRefList<gzDistDebugManagerClient> m_managerClients;
};

//-------------------------- gzDistDebugNotification ---------------------------

class gzDistDebugNotification : public gzDistNotification
{
    public:
        // Constructor
        gzDistDebugNotification();

        // Destructor
        virtual ~gzDistDebugNotification();

        // Set m_debugMessageType
        gzVoid setDebugMessageType(gzDistDebugMessageType debugMessageType);

        // Get m_debugMessageType
        gzDistDebugMessageType getDebugMessageType();

        // Set class type.
        gzVoid setDebugClassType(gzType* classType);

        // Get class type.
        gzType* getDebugClassType();

        // Set m_stringData1.
        gzVoid setDebugSessionName(const gzString& name);

        // Set m_stringData2.
        gzVoid setDebugObjectName(const gzString& name);

        // Set m_stringData3.
        gzVoid setDebugAttributeName(const gzString& name);

        // Set threaad pool id.
        gzVoid setDebugPoolId(gzULong poolId);

        // Get m_stringData1.
        const gzString& getDebugObjectName() const;

        // Get m_stringData2.
        const gzString& getDebugSessionName() const;

        // Get m_stringData3.
        const gzString& getDebugAttributeName() const;

        // Set additional clients i.e. ownership data.
        gzVoid setDebugClients(gzRefList<gzRefData<gzDistClientID> >* clients);

        // Get ownership data.
        gzRefList<gzRefData<gzDistClientID> >* getDebugClients();

        // Get threaad pool id.
        gzULong getDebugPoolId();

    private:

        // Debug message type.
        gzDistDebugMessageType m_debugMessageType;

        gzString m_stringData1;

        gzString m_stringData2;

        gzString m_stringData3;

        gzType* m_classType;

        gzRefList<gzRefData<gzDistClientID> >* m_clientIds;

        gzULong m_poolId;
};

#endif

---