gzDistClientThreadPool.h

Go to the documentation of this file.

//*****************************************************************************
// File         : gzDistClientThreadPool.h
// Module       : gzDistribution
// Description  : Definition of a gzDistClientThreadPool
// 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  040130  Created file    
//
//*****************************************************************************
#ifndef __GZ_DIST_CLIENT_THREAD_POOL_H__
#define __GZ_DIST_CLIENT_THREAD_POOL_H__

// Includes
#include "gzDistBase.h"

// Forward declaration
class gzDistClientThread;
class gzDistClientInterface;

// ---------------------------- gzDistThread -------------------------------
// Pure virtual super class for all kind of threads in pool.
class gzDistThreadInterface
{
    public:
        gzDistThreadInterface() : m_threadId(0){}
        virtual ~gzDistThreadInterface() {}

        gzVoid trigger();

        gzULong getThreadId();

    protected:

        // Used for optimized response.
        gzDistTrigger m_trigger;

        // The thread id.
        gzULong m_threadId;
};

//-------------------------- gzDistClientThreadPool ---------------------------

// Client thread pool that manages client threads
class gzDistClientThreadPool : public gzDistThreadInterface
{
    public:

        gzDistClientThreadPool();
        ~gzDistClientThreadPool();

        gzDistThreadInterface* registerClient(gzDistClientInterface* client, gzULong poolId, gzULong threadId);
        gzBool unregisterClient(gzDistClientInterface* client, gzULong poolId, gzULong threadId);
        gzVoid shutDown();

        // Returns TRUE if there are working threads or clients registered.
        gzBool isActive();

        gzBool processCustomThreadClients(gzBool waitForTrigger);

        gzULong getCustomThreadId();

        // Process the pool for the calling thread.
        gzBool processPool();

    protected:      

    private:

        gzDistClientThread* getThreadPool(gzULong poolId);

        gzDistClientThread* getThreadPoolByThread(gzULong threadId);

    // Members:

        gzList<gzDistClientThread> m_threadPool;

        // List of custom clients
        gzList<gzDistClientInterface> m_customClients;
        
        // Mutex for m_customClients
        gzMutex m_customClientsLocker;

        // Tell the thread reset the iterator to avoid working with destroied data.
        gzBool m_doReset;
};


//--------------------------- gzDistClientThread ------------------------------

// Client thread
class gzDistClientThread : public gzThread, public gzDistThreadInterface
{
    public:

        gzDistClientThread(gzULong poolId);
        virtual ~gzDistClientThread();
        
        // Add a client to this pool.
        gzBool addClient(gzDistClientInterface* client);

        // Add a client to this pool outside mutex.
        gzBool addClientUnlocked(gzDistClientInterface* client);

        // Remove a client from this pool.
        gzBool removeClient(gzDistClientInterface* client);

        // Remove a client from this pool outside mutex.
        gzBool removeClientUnlocked(gzDistClientInterface* client);

        // Get the number of clients in this pool
        gzUInt getClients();

        // Run the thread.
        gzVoid activate();

        // Stop the thread.
        gzVoid terminate();

        gzULong getPoolId();

        gzULong getPoolThreadId();

        gzVoid singleProcess();

    protected:
        
        gzVoid process();

    private:

        gzList<gzDistClientInterface> m_clients;
        gzMutex m_clientsLocker;

        // The id of the pool.
        const gzULong m_poolId;

        // Tells if the thread is running.
        gzBool m_running;

        // Tell the thread reset the iterator to avoid working with destroied data.
        gzBool m_doReset;
};


#endif

---