gzDistServer.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistServer.h
// Module       : gzDistribution
// Description  : Definition of gzDistServerInterface
// 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  031030  Created file    
//
//******************************************************************************
#ifndef __GZ_DIST_SERVER_H__
#define __GZ_DIST_SERVER_H__

// Includes
#include "gzDistBase.h"

// Forward declarations
class gzDistServerImpl;
class gzDistServerMessage;
class gzDistRemoteChannelInterface;


enum gzDistServerPriority
{
    GZ_DIST_SERVER_PRIO_NEVER = 0,  
    GZ_DIST_SERVER_PRIO_VERY_LOW,   
    GZ_DIST_SERVER_PRIO_LOW,        
    GZ_DIST_SERVER_PRIO_NORMAL,     
    GZ_DIST_SERVER_PRIO_HIGH,       
    GZ_DIST_SERVER_PRIO_VERY_HIGH,  
    GZ_DIST_SERVER_PRIO_MAX         
};


enum gzDistServerStatus
{
    GZ_DIST_SERVER_STATUS_UNKNOWN = 0,  
    GZ_DIST_SERVER_STATUS_IDLE,         
    GZ_DIST_SERVER_STATUS_STARTUP,      
    GZ_DIST_SERVER_STATUS_PASSIVE,      
    GZ_DIST_SERVER_STATUS_ACTIVE,       
    GZ_DIST_SERVER_STATUS_SHUTDOWN,     
    GZ_DIST_SERVER_STATUS_ERROR         
};


enum gzDistServerRemoveReason
{
    GZ_DIST_SERVER_REMOVE_SHUTDOWN = 0,
    GZ_DIST_SERVER_REMOVE_TIMEOUT
}; 


//*****************************************************************************
// Class    : gzDistServerInterface
//                                  
// Purpose  : Priority based distributed server support
//                                  
// Notes    : - 
//                                  
// Revision History...                          
//                                  
// Who  Date    Description                     
//                                  
// XAA  031030  Created 
//                                  
//*****************************************************************************

class gzDistServerInterface : protected gzThreadTicker
{
    public:


        GZ_DIST_EXPORT gzDistServerInterface(const gzString& functionID, gzDistServerPriority priority = GZ_DIST_SERVER_PRIO_NORMAL, gzBool customNotificationThread = FALSE);

        GZ_DIST_EXPORT virtual ~gzDistServerInterface();


        GZ_DIST_EXPORT gzVoid install();


        GZ_DIST_EXPORT gzVoid uninstall(gzBool wait = TRUE);


        GZ_DIST_EXPORT gzBool isInstalled() const;


        GZ_DIST_EXPORT gzString getFunctionID() const;

        GZ_DIST_EXPORT gzDistServerPriority getPriority() const;


        GZ_DIST_EXPORT gzVoid triggerNotifications();


    protected:

        //------------ callbacks ------------


        GZ_DIST_EXPORT virtual gzVoid onStatus(gzDistServerStatus status);


        GZ_DIST_EXPORT virtual gzVoid onNewInstance(const gzDistInstanceID& id);


        GZ_DIST_EXPORT virtual gzVoid onRemoveInstance(const gzDistInstanceID& id, gzDistServerRemoveReason reason);


        GZ_DIST_EXPORT virtual gzVoid onActiveInstance(const gzDistInstanceID& id);


    protected:

        // Notification thread ticker 
        GZ_DIST_EXPORT gzVoid onInitialize();
        GZ_DIST_EXPORT gzVoid onTick();
        GZ_DIST_EXPORT gzVoid onTerminate();

        // Process notifications
        gzVoid processNotifications();


    private:

        // Server implementation
        gzDistServerImpl * m_impl;

        // Messages from server implementation
        gzList<gzDistServerMessage>* m_messageList;

        // True whan a custom notification thread is used.
        gzBool m_customThread;

        // True while the ticker is running
        gzBool m_running;

};


#endif 

---