PluginInterface2.h

Go to the documentation of this file.

#ifndef __PLUGIN_INTERFACE_2_H
#define __PLUGIN_INTERFACE_2_H

#include "NativeFeatureIncludes.h"

class RakPeerInterface;
class PacketizedTCP;
struct Packet;
struct InternalPacket;



enum PluginReceiveResult
{
        RR_STOP_PROCESSING_AND_DEALLOCATE=0,

        RR_CONTINUE_PROCESSING,

        RR_STOP_PROCESSING,
};

#include "RakNetTypes.h"
#include "Export.h"
#include "PacketPriority.h"

enum PI2_LostConnectionReason
{
        LCR_CLOSED_BY_USER,

        LCR_DISCONNECTION_NOTIFICATION,

        LCR_CONNECTION_LOST
};

enum PI2_FailedConnectionAttemptReason
{
        FCAR_CONNECTION_ATTEMPT_FAILED,
        FCAR_ALREADY_CONNECTED,
        FCAR_NO_FREE_INCOMING_CONNECTIONS,
        FCAR_RSA_PUBLIC_KEY_MISMATCH,
        FCAR_CONNECTION_BANNED,
        FCAR_INVALID_PASSWORD,
        FCAR_INCOMPATIBLE_PROTOCOL,
        FCAR_IP_RECENTLY_CONNECTED
};

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

        virtual void OnAttach(void) {}

        virtual void OnDetach(void) {}

        virtual void Update(void) {}

        virtual PluginReceiveResult OnReceive(Packet *packet) {(void) packet; return RR_CONTINUE_PROCESSING;}

        virtual void OnRakPeerStartup(void) {}

        virtual void OnRakPeerShutdown(void) {}

        virtual void OnClosedConnection(SystemAddress systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason ){(void) systemAddress; (void) rakNetGUID; (void) lostConnectionReason;}

        virtual void OnNewConnection(SystemAddress systemAddress, RakNetGUID rakNetGUID, bool isIncoming) {(void) systemAddress; (void) rakNetGUID; (void) isIncoming;}

        virtual void OnFailedConnectionAttempt(Packet *packet, PI2_FailedConnectionAttemptReason failedConnectionAttemptReason) {(void) packet; (void) failedConnectionAttemptReason;}

        virtual void OnDirectSocketSend(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress) {(void) data; (void) bitsUsed; (void) remoteSystemAddress;}
        
        virtual void OnDirectSocketReceive(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress) {(void) data; (void) bitsUsed; (void) remoteSystemAddress;}

        virtual void OnReliabilityLayerPacketError(const char *errorMessage, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress)  {(void) errorMessage; (void) bitsUsed; (void) remoteSystemAddress;}
        
        virtual void OnInternalPacket(InternalPacket *internalPacket, unsigned frameNumber, SystemAddress remoteSystemAddress, RakNetTime time, int isSend) {(void) internalPacket; (void) frameNumber; (void) remoteSystemAddress; (void) time; (void) isSend;}

        virtual void OnAck(unsigned int messageNumber, SystemAddress remoteSystemAddress, RakNetTime time) {(void) messageNumber; (void) remoteSystemAddress; (void) time;}

        virtual void OnPushBackPacket(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress) {(void) data; (void) bitsUsed; (void) remoteSystemAddress;}

        RakPeerInterface *GetRakPeerInterface(void) const {return rakPeerInterface;}

        void SetRakPeerInterface( RakPeerInterface *ptr );

#if _RAKNET_SUPPORT_PacketizedTCP==1

        void SetPacketizedTCP( PacketizedTCP *ptr );
#endif
protected:
        // Send through either rakPeerInterface or packetizedTCP, whichever is available
        void SendUnified( const RakNet::BitStream * bitStream, PacketPriority priority, PacketReliability reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast );
        bool SendListUnified( const char **data, const int *lengths, const int numParameters, PacketPriority priority, PacketReliability reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast );

        Packet *AllocatePacketUnified(unsigned dataSize);
        void PushBackPacketUnified(Packet *packet, bool pushAtHead);
        void DeallocPacketUnified(Packet *packet);

        // Filled automatically in when attached
        RakPeerInterface *rakPeerInterface;
#if _RAKNET_SUPPORT_PacketizedTCP==1
        PacketizedTCP *packetizedTCP;
#endif
};

#endif