MessageFilter.h

Go to the documentation of this file.

#include "NativeFeatureIncludes.h"
#if _RAKNET_SUPPORT_MessageFilter==1

#ifndef __MESSAGE_FILTER_PLUGIN_H
#define __MESSAGE_FILTER_PLUGIN_H

#include "RakNetTypes.h"
#include "PluginInterface2.h"
#include "DS_OrderedList.h"
#include "DS_Hash.h"
#include "Export.h"

#define MESSAGE_FILTER_MAX_MESSAGE_ID 256

namespace RakNet
{
class RakPeerInterface;

int RAK_DLL_EXPORT MessageFilterStrComp( char *const &key,char *const &data );

struct FilterSet
{
    bool banOnFilterTimeExceed;
    bool kickOnDisallowedMessage;
    bool banOnDisallowedMessage;
    RakNet::TimeMS disallowedMessageBanTimeMS;
    RakNet::TimeMS timeExceedBanTimeMS;
    RakNet::TimeMS maxMemberTimeMS;
    void (*invalidMessageCallback)(RakPeerInterface *peer, AddressOrGUID systemAddress, int filterSetID, void *userData, unsigned char messageID);
    void *disallowedCallbackUserData;
    void (*timeoutCallback)(RakPeerInterface *peer, AddressOrGUID systemAddress, int filterSetID, void *userData);
    void *timeoutUserData;
    int filterSetID;
    bool allowedIDs[MESSAGE_FILTER_MAX_MESSAGE_ID];
    DataStructures::OrderedList<RakNet::RakString,RakNet::RakString> allowedRPC4;
};

int RAK_DLL_EXPORT FilterSetComp( const int &key, FilterSet * const &data );

struct FilteredSystem
{
    FilterSet *filter;
    RakNet::TimeMS timeEnteredThisSet;
};


class RAK_DLL_EXPORT MessageFilter : public PluginInterface2
{
public:

    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(MessageFilter)

    MessageFilter();
    virtual ~MessageFilter();

    // --------------------------------------------------------------------------------------------
    // User functions
    // --------------------------------------------------------------------------------------------

    void SetAutoAddNewConnectionsToFilter(int filterSetID);

    void SetAllowMessageID(bool allow, int messageIDStart, int messageIDEnd,int filterSetID);

    void SetAllowRPC4(bool allow, const char* uniqueID, int filterSetID);

    void SetActionOnDisallowedMessage(bool kickOnDisallowed, bool banOnDisallowed, RakNet::TimeMS banTimeMS, int filterSetID);

    void SetDisallowedMessageCallback(int filterSetID, void *userData, void (*invalidMessageCallback)(RakPeerInterface *peer, AddressOrGUID addressOrGUID, int filterSetID, void *userData, unsigned char messageID));

    void SetTimeoutCallback(int filterSetID, void *userData, void (*invalidMessageCallback)(RakPeerInterface *peer, AddressOrGUID addressOrGUID, int filterSetID, void *userData));

    void SetFilterMaxTime(int allowedTimeMS, bool banOnExceed, RakNet::TimeMS banTimeMS, int filterSetID);

    int GetSystemFilterSet(AddressOrGUID addressOrGUID);

    void SetSystemFilterSet(AddressOrGUID addressOrGUID, int filterSetID);

    unsigned GetSystemCount(int filterSetID) const;

    unsigned GetFilterSetCount(void) const;

    int GetFilterSetIDByIndex(unsigned index);

    void DeleteFilterSet(int filterSetID);

    // --------------------------------------------------------------------------------------------
    // Packet handling functions
    // --------------------------------------------------------------------------------------------
    virtual void Update(void);
    virtual PluginReceiveResult OnReceive(Packet *packet);
    virtual void OnNewConnection(const SystemAddress &systemAddress, RakNetGUID rakNetGUID, bool isIncoming);
    virtual void OnClosedConnection(const SystemAddress &systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason );

protected:

    void Clear(void);
    void DeallocateFilterSet(FilterSet *filterSet);
    FilterSet* GetFilterSetByID(int filterSetID);
    void OnInvalidMessage(FilterSet *filterSet, AddressOrGUID systemAddress, unsigned char messageID);

    DataStructures::OrderedList<int, FilterSet*, FilterSetComp> filterList;
    // Change to guid
    DataStructures::Hash<AddressOrGUID, FilteredSystem, 2048, AddressOrGUID::ToInteger> systemList;

    int autoAddNewConnectionsToFilter;
    RakNet::Time whenLastTimeoutCheck;
};

} // namespace RakNet

#endif

#endif // _RAKNET_SUPPORT_*