msghandler.h

Go to the documentation of this file.

/*
 * msghandler.h by Matze Braun <MatzeBraun@gmx.de>
 *
 * Copyright (C) 2001 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 __MSGHANDLER_H__
#define __MSGHANDLER_H__

#include <csutil/parray.h>
#include <csutil/refcount.h>
#include <csutil/threading/thread.h>
#include <csutil/threading/rwmutex.h>

#include "net/message.h"
#include "net/netbase.h"

// forward decls
struct iNetSubscriber;
class NetBase;
class Client;

//-----------------------------------------------------------------------------


struct Subscription
{
    uint32_t flags; 
    iNetSubscriber* subscriber; 
    Subscription(iNetSubscriber *nSubscriber, uint32_t nFlags = 0x01/*REQUIRE_READY_CLIENT*/)
        : flags(nFlags), subscriber(nSubscriber)
    {
    }

    // comparison operator required for usage in csHash
    bool operator<(const Subscription& other) const
    {
        return subscriber < other.subscriber;
    }
};


//-----------------------------------------------------------------------------


struct OrderedMessageChannel
{
    int nextSequenceNumber;
    csRefArray<MsgEntry> pendingMessages;

    OrderedMessageChannel() : nextSequenceNumber(0) { }

    int GetCurrentSequenceNumber() { return nextSequenceNumber; }

    int IncrementSequenceNumber()
    {
        nextSequenceNumber++;
        if (nextSequenceNumber > 63)  // must be clamped to 6 bit value
            nextSequenceNumber = 1;    // can't use zero because that means unsequenced

        return nextSequenceNumber;
    }
};

//-----------------------------------------------------------------------------

class MsgHandler : public csRefCount
{
public:
    MsgHandler();
    virtual ~MsgHandler();

    bool Initialize(NetBase *nb, int queuelen = 500);

    virtual void Subscribe(iNetSubscriber *subscriber, msgtype type, uint32_t flags = 0x01/*REQUIRE_READY_CLIENT*/);

    virtual bool Unsubscribe(iNetSubscriber *subscriber , msgtype type);

    virtual bool UnsubscribeAll(iNetSubscriber *subscriber);

    void Publish(MsgEntry *msg);

    typedef NetBase::broadcasttype broadcasttype;

    virtual void SendMessage(MsgEntry *msg)
    { netbase->SendMessage(msg); }

    virtual void Broadcast(MsgEntry* msg, broadcasttype scope = NetBase::BC_EVERYONEBUTSELF, int guildID=-1)
    { netbase->Broadcast(msg, scope, guildID); }

    virtual void Multicast(MsgEntry* msg, csArray<PublishDestination>& multi, uint32_t except, float range)
    { netbase->Multicast(msg, multi, except, range); }

    void AddToLocalQueue(MsgEntry *me) { netbase->QueueMessage(me); }

    csTicks GetPing() { return netbase->GetPing(); }

    bool Flush() { return netbase->Flush(queue); }

protected:
    NetBase                       *netbase;
    MsgQueue                      *queue;

    csHash<Subscription, msgtype> subscribers;
    CS::Threading::ReadWriteMutex mutex; 
};

#endif