gzDistRemoteMessage.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistRemoteMessage.h
// Module       : gzDistribution
// Description  : Definition of gzDistRemoteMessage
// Author       : Anders Sandblad
// 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
//
// XAA  031113  Created file
//
//*****************************************************************************
#ifndef __GZ_DIST_REMOTE_MESSAGE_H__
#define __GZ_DIST_REMOTE_MESSAGE_H__

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

enum gzDistRemoteMessageClass
{
    GZ_DIST_REMOTE_MESSAGE_CLASS_UNKNOWN = 0,
    GZ_DIST_REMOTE_MESSAGE_CLASS_SERVER,                // 
    GZ_DIST_REMOTE_MESSAGE_CLASS_SESSION,               // 
    GZ_DIST_REMOTE_MESSAGE_REQUEST_RESEND,              // Used in reliable mode to request missed messages.
    GZ_DIST_REMOTE_MESSAGE_INDEX_DISTRIBUTION,          // Used in reliable mode to distribute current message index.
    GZ_DIST_REMOTE_MESSAGE_BUFFER_INDEX_LIMIT,          // Used in reliable mode to distribute the start index of its resend buffer.
    GZ_DIST_REMOTE_MESSAGE_INDEX_ACK_REQUEST,           // Used in reliable mode to request acknowledge on index.
    GZ_DIST_REMOTE_MESSAGE_INDEX_ACK,                   // Used in reliable mode to acknowledge received index.
    GZ_DIST_REMOTE_MESSAGE_SHUTDOWN,                    // Used in reliable mode to tell other processes about shutdown.
    GZ_DIST_REMOTE_MESSAGE_SPECIAL_COMMANDS,            // Here begins all special debug messages etc. This number is never used!
    GZ_DIST_REMOTE_MESSAGE_HOST_INFO_REQUEST,
    GZ_DIST_REMOTE_MESSAGE_HOST_INFO_REPLY,
    GZ_DIST_REMOTE_MESSAGE_CLASS_MAX_CLASS              // The last item
};


enum gzDistRemoteMessageType
{
    GZ_DIST_REMOTE_MESSAGE_TYPE_UNKNOWN = 0,

    // Server class messages
    GZ_DIST_REMOTE_MESSAGE_SERVER_PING,
    GZ_DIST_REMOTE_MESSAGE_SERVER_REQUEST_SYNCHRONIZE,  // Request a total synchronization from the active server. (Sent from non-server).
    GZ_DIST_REMOTE_MESSAGE_SERVER_END_SYNCHRONIZE,      // Tells that the synchronization is finished. (Sent from server).
    GZ_DIST_REMOTE_MESSAGE_SERVER_REQUEST_UPDATE,       // Request all data from a none-server. (Sent from server).
    GZ_DIST_REMOTE_MESSAGE_SERVER_END_UPDATE,           // Tells that the data transmission is finished. (Sent from non-server).

    // Session class messages
    GZ_DIST_REMOTE_MESSAGE_SESSION_EVENT,
    GZ_DIST_REMOTE_MESSAGE_SESSION_NEW_OBJECT,
    GZ_DIST_REMOTE_MESSAGE_SESSION_NEW_OBJECT_REQUEST,
    GZ_DIST_REMOTE_MESSAGE_SESSION_UPDATE_OBJECT,
    GZ_DIST_REMOTE_MESSAGE_SESSION_UPDATE_OBJECT_REQUEST,
    GZ_DIST_REMOTE_MESSAGE_SESSION_REMOVE_OBJECT,
    GZ_DIST_REMOTE_MESSAGE_SESSION_REMOVE_OBJECT_REQUEST,
    GZ_DIST_REMOTE_MESSAGE_SESSION_REMOVE_ATTRIBUTES,
    GZ_DIST_REMOTE_MESSAGE_SESSION_REMOVE_ATTRIBUTES_REQUEST,
    GZ_DIST_REMOTE_MESSAGE_SESSION_REQUEST_OWNERSHIP,
    GZ_DIST_REMOTE_MESSAGE_SESSION_DROP_OWNERSHIP,              // Used for drop request and drop request remove.
    GZ_DIST_REMOTE_MESSAGE_SESSION_SET_OWNERSHIP,
    GZ_DIST_REMOTE_MESSAGE_SESSION_PULL_OWNERSHIP,
    GZ_DIST_REMOTE_MESSAGE_SESSION_SYNCHRONIZE_OBJECT,
    GZ_DIST_REMOTE_MESSAGE_SESSION_MAX_TYPE                     // The last item
};


//--------------------------- gzDistRemoteMessage -----------------------------

class gzDistRemoteMessage : public gzReference
{
    public:

        GZ_DIST_EXPORT gzDistRemoteMessage();

        GZ_DIST_EXPORT gzDistRemoteMessage(gzUByte msgClass, gzUByte msgType);

        GZ_DIST_EXPORT virtual ~gzDistRemoteMessage();
        
        virtual gzReference* clone() const { return (gzReference *) new gzDistRemoteMessage(*this); }

        gzBool useDeepCopy() { return FALSE; }


        //---------- header data ----------

        gzDistInstanceID senderID;
        
        gzDistInstanceID destinationID;

        gzRefList<gzDistSerializeMemoryData> data;

        gzUByte messageClass;

        gzUByte messageType;

        gzUInt highPrio;
};

// Auto reference pointer and list
GZ_DIST_PTR(gzDistRemoteMessage);
GZ_DIST_LIST(gzDistRemoteMessage);


//------------------------ gzDistRemoteMessageServer --------------------------

// Remote server message
class gzDistRemoteMessageServer : public gzDistRemoteMessage
{
    public:

        gzDistRemoteMessageServer(gzUByte msgType)
        : gzDistRemoteMessage(GZ_DIST_REMOTE_MESSAGE_CLASS_SERVER, msgType)
        { }
    
        virtual ~gzDistRemoteMessageServer() { }

        virtual gzReference* clone() const { return (gzReference*) new gzDistRemoteMessageServer(*this); }


        //---------- body data ----------
        
        // Server status (gzDistServerStatus)
        gzUByte status;
        
        // Server base priority (gzDistServerPriority)
        gzUByte priority;

        // Source server instance ID
        gzDistInstanceID sourceID;
        
        // Server function ID
        gzString functionID;

};

// Auto reference pointer and list
GZ_DIST_PTR(gzDistRemoteMessageServer);
GZ_DIST_LIST(gzDistRemoteMessageServer);


//------------------------ gzDistRemoteMessageSession -------------------------

GZ_DIST_DECLARE_MEMBASE_EXPORT(gzDistRemoteMessageSession, GZ_DIST_EXPORT);

// Remote session message
class gzDistRemoteMessageSession : public gzDistRemoteMessage
{
    public:

        GZ_DIST_EXPORT gzDistRemoteMessageSession(gzUByte messageType);

        gzDistRemoteMessageSession(const gzString& sessionName, gzUByte msgClass, gzUByte msgType);
            
        GZ_DIST_EXPORT virtual ~gzDistRemoteMessageSession();
        
        virtual gzReference* clone() const { return (gzReference*) new gzDistRemoteMessageSession(*this); }


        //---------- body data ----------

        // The name of the session
        gzString sessionName;

        // Class type of the data (TypeName) declared in gzTypeInterface.
        gzString dataType;

        // The identification of the sendign client.
        gzDistClientID clientID;

        // The position in data array where the serialized data begins. (Only used in incoming messages)
        gzUInt dataPosition;
};

// Auto reference pointer and list
GZ_DIST_PTR(gzDistRemoteMessageSession);
GZ_DIST_LIST(gzDistRemoteMessageSession);

#endif

---