msgmanager.h

Go to the documentation of this file.

/*
 * msgmanager.h
 *
 * Copyright (C) 2005 Atomic Blue (info@planeshift.it, http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
#ifndef __MSGMANAGER_H__
#define __MSGMANAGER_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/ref.h>

//=============================================================================
// Project Includes
//=============================================================================
#include "net/subscriber.h"         // Subscriber class
#include "net/message.h"            // For msgtype typedef
#include "util/eventmanager.h"
#include "globals.h"

//=============================================================================
// Local Includes
//=============================================================================

class Client;
class gemObject;
class gemActor;
class MsgEntry;
class GEMSupervisor;

#define NO_VALIDATION                0x00
#define REQUIRE_ANY_CLIENT           0x01
#define REQUIRE_READY_CLIENT         0x02
#define REQUIRE_ALREADY_READY_CLIENT 0x04
#define REQUIRE_ACTOR                0x08
#define REQUIRE_ALIVE                0x10
#define REQUIRE_TARGET               0x20
#define REQUIRE_TARGETACTOR          0x40
#define REQUIRE_TARGETNPC            0x80


class MessageManagerBase : public iNetSubscriber
{
public:

    virtual bool Verify(MsgEntry* pMsg, unsigned int flags, Client* &client);

    Client* FindPlayerClient(const char* name);

    csArray<csString> DecodeCommandArea(Client* client, csString target);

    gemObject* FindObjectByString(const csString &str, gemActor* me) const;
};

template <class SubClass>
class MessageManager : public MessageManagerBase
{
public:
    typedef void(SubClass::*FunctionPointer)(MsgEntry*, Client*);

    virtual ~MessageManager()
    {
        UnsubscribeAll();
    }

    inline void Subscribe(FunctionPointer fpt, msgtype type, uint32_t flags = 0x01)
    {
        CS::Threading::RecursiveMutexScopedLock lock(mutex);
        if(!handlers.Contains(type))
        {
            GetEventManager()->Subscribe(this, type, flags);
        }
        handlers.Put(type, fpt);
    }

    inline bool Unsubscribe(msgtype type)
    {
        CS::Threading::RecursiveMutexScopedLock lock(mutex);
        if(handlers.Contains(type))
        {
            handlers.DeleteAll(type);
            return GetEventManager()->Unsubscribe(this, type);
        }
        return false;
    }

    inline bool Unsubscribe(FunctionPointer handler, msgtype type)
    {
        CS::Threading::RecursiveMutexScopedLock lock(mutex);
        if(handlers.Contains(type))
        {
            handlers.Delete(type, handler);
            if(!handlers.Contains(type))
            {
                return GetEventManager()->Unsubscribe(this, type);
            }
            else
            {
                return true;
            }
        }
        else
        {
            return false;
        }
    }

    inline bool UnsubscribeAll()
    {
        CS::Threading::RecursiveMutexScopedLock lock(mutex);
        handlers.Empty();
        if(psserver->GetEventManager())
            return GetEventManager()->UnsubscribeAll(this);
        return false;
    }

    void HandleMessage(MsgEntry* msg, Client* client)
    {
        csArray<FunctionPointer> msgHandlers;
        {
            CS::Threading::RecursiveMutexScopedLock lock(mutex);
            msgHandlers = handlers.GetAll(msg->GetType());
        }
        SubClass* self = dynamic_cast<SubClass*>(this);
        if(!self)
        {
            // fatal error, we aren't a base of our subclass!
            return;
        }

        for(size_t i = 0; i < msgHandlers.GetSize(); ++i)
        {
            (self->*msgHandlers[i])(msg, client);
        }
    }

private:
    CS::Threading::RecursiveMutex mutex;
    csHash<FunctionPointer, msgtype> handlers;

    inline EventManager* GetEventManager() const
    {
        EventManager* eventManager = psserver->GetEventManager();
        CS_ASSERT(eventManager);
        return eventManager;
    }
};

#endif