ConnectionGraph.h

Go to the documentation of this file.

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

#ifndef __CONNECTION_GRAPH_H
#define __CONNECTION_GRAPH_H

class RakPeerInterface;
#include "RakMemoryOverride.h"
#include "RakNetTypes.h"
#include "PluginInterface2.h"
#include "DS_List.h"
#include "DS_WeightedGraph.h"
#include "GetTime.h"
#include "Export.h"


// If you need more than 255 groups just change this typedef
typedef unsigned char ConnectionGraphGroupID;

class RAK_DLL_EXPORT ConnectionGraph : public PluginInterface2
{
public:
        ConnectionGraph();
        virtual ~ConnectionGraph();

        struct RAK_DLL_EXPORT SystemAddressAndGroupId
        {
                SystemAddressAndGroupId();
                ~SystemAddressAndGroupId();
                SystemAddressAndGroupId(SystemAddress _systemAddress, ConnectionGraphGroupID _groupID, RakNetGUID _guid);

                SystemAddress systemAddress;
                ConnectionGraphGroupID groupId;
                RakNetGUID guid;

                bool operator==( const SystemAddressAndGroupId& right ) const;
                bool operator!=( const SystemAddressAndGroupId& right ) const;
                bool operator > ( const SystemAddressAndGroupId& right ) const;
                bool operator < ( const SystemAddressAndGroupId& right ) const;
        };

        // --------------------------------------------------------------------------------------------
        // User functions
        // --------------------------------------------------------------------------------------------
        void SetPassword(const char *password);

        DataStructures::WeightedGraph<ConnectionGraph::SystemAddressAndGroupId, unsigned short, false> *GetGraph(void);

        void SetAutoAddNewConnections(bool autoAdd);

        void RequestConnectionGraph(SystemAddress systemAddress);

        void AddNewConnection(RakPeerInterface *peer, SystemAddress systemAddress, RakNetGUID guid, ConnectionGraphGroupID groupId);

        void SetGroupId(ConnectionGraphGroupID groupId);

        void SubscribeToGroup(ConnectionGraphGroupID groupId);

        void UnsubscribeFromGroup(ConnectionGraphGroupID groupId);

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

protected:
        void HandleDroppedConnection(RakPeerInterface *peer, SystemAddress systemAddress, unsigned char packetId);
        void DeleteFromPeerList(SystemAddress systemAddress);

        void OnNewIncomingConnection(Packet *packet);
        void OnConnectionGraphRequest(Packet *packet);
        void OnConnectionGraphReply(Packet *packet);
        void OnConnectionGraphUpdate(Packet *packet);
        void OnNewConnectionInternal(Packet *packet);
        bool OnConnectionLostInternal(Packet *packet, unsigned char packetId);
        void OnConnectionAddition(Packet *packet);
        void OnConnectionRemoval(Packet *packet);
        void SendConnectionGraph(SystemAddress target, unsigned char packetId, RakPeerInterface *peer);
        void SerializeWeightedGraph(RakNet::BitStream *out, const DataStructures::WeightedGraph<ConnectionGraph::SystemAddressAndGroupId, unsigned short, false> &g) const;
        bool DeserializeWeightedGraph(RakNet::BitStream *inBitstream, RakPeerInterface *peer);
        void AddAndRelayConnection(DataStructures::OrderedList<SystemAddress,SystemAddress> &ignoreList, const SystemAddressAndGroupId &conn1, const SystemAddressAndGroupId &conn2, unsigned short ping, RakPeerInterface *peer);
        bool RemoveAndRelayConnection(DataStructures::OrderedList<SystemAddress,SystemAddress> &ignoreList, unsigned char packetId, const SystemAddress node1, const SystemAddress node2, RakPeerInterface *peer);
        void RemoveParticipant(SystemAddress systemAddress);
        void AddParticipant(SystemAddress systemAddress);
        void BroadcastGraphUpdate(DataStructures::OrderedList<SystemAddress,SystemAddress> &ignoreList, RakPeerInterface *peer);
        void NotifyUserOfRemoteConnection(const SystemAddressAndGroupId &conn1, const SystemAddressAndGroupId &conn2,unsigned short ping, RakPeerInterface *peer);
        bool IsNewRemoteConnection(const SystemAddressAndGroupId &conn1, const SystemAddressAndGroupId &conn2,RakPeerInterface *peer);
        bool DeserializeIgnoreList(DataStructures::OrderedList<SystemAddress,SystemAddress> &ignoreList, RakNet::BitStream *inBitstream );
        void SerializeIgnoreListAndBroadcast(RakNet::BitStream *outBitstream, DataStructures::OrderedList<SystemAddress,SystemAddress> &ignoreList, RakPeerInterface *peer);

        RakNetTime nextWeightUpdate;
        char *pw;
        DataStructures::OrderedList<SystemAddress, SystemAddress> participantList;

        DataStructures::WeightedGraph<ConnectionGraph::SystemAddressAndGroupId, unsigned short, false> graph;
        bool autoAddNewConnections;
        ConnectionGraphGroupID myGroupId;

        DataStructures::OrderedList<ConnectionGraphGroupID, ConnectionGraphGroupID> subscribedGroups;

        // Used to broadcast new connections after some time so the pings are correct
        //RakNetTime forceBroadcastTime;
};

#endif

#endif // _RAKNET_SUPPORT_*