PluginInterface2.h

Go to the documentation of this file.

/*
 *  Original work: Copyright (c) 2014, Oculus VR, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  RakNet License.txt file in the licenses directory of this source tree. An additional grant 
 *  of patent rights can be found in the RakNet Patents.txt file in the same directory.
 *
 *
 *  Modified work: Copyright (c) 2017, SLikeSoft UG (haftungsbeschränkt)
 *
 *  This source code was modified by SLikeSoft. Modifications are licensed under the MIT-style
 *  license found in the license.txt file in the root directory of this source tree.
 */



#ifndef __PLUGIN_INTERFACE_2_H
#define __PLUGIN_INTERFACE_2_H

#include "NativeFeatureIncludes.h"
#include "types.h"
#include "Export.h"
#include "PacketPriority.h"

namespace SLNet {

class RakPeerInterface;
class TCPInterface;
struct Packet;
struct InternalPacket;



enum PluginReceiveResult
{
    RR_STOP_PROCESSING_AND_DEALLOCATE=0,

    RR_CONTINUE_PROCESSING,

    RR_STOP_PROCESSING
};

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_SECURITY_PUBLIC_KEY_MISMATCH,
    FCAR_CONNECTION_BANNED,
    FCAR_INVALID_PASSWORD,
    FCAR_INCOMPATIBLE_PROTOCOL,
    FCAR_IP_RECENTLY_CONNECTED,
    FCAR_REMOTE_SYSTEM_REQUIRES_PUBLIC_KEY,
    FCAR_OUR_SYSTEM_REQUIRES_SECURITY,
    FCAR_PUBLIC_KEY_MISMATCH
};

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(const SystemAddress &systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason ){(void) systemAddress; (void) rakNetGUID; (void) lostConnectionReason;}

    virtual void OnNewConnection(const 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 bool UsesReliabilityLayer(void) const {return false;}

    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 OnReliabilityLayerNotification(const char *errorMessage, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress, bool isError)  {(void) errorMessage; (void) bitsUsed; (void) remoteSystemAddress; (void) isError;}
    
    virtual void OnInternalPacket(InternalPacket *internalPacket, unsigned frameNumber, SystemAddress remoteSystemAddress, SLNet::TimeMS time, int isSend) {(void) internalPacket; (void) frameNumber; (void) remoteSystemAddress; (void) time; (void) isSend;}

    virtual void OnAck(unsigned int messageNumber, SystemAddress remoteSystemAddress, SLNet::TimeMS 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;}

    RakNetGUID GetMyGUIDUnified(void) const;

    void SetRakPeerInterface( RakPeerInterface *ptr );

#if _RAKNET_SUPPORT_TCPInterface==1

    void SetTCPInterface( TCPInterface *ptr );
#endif

protected:
    // Send through either rakPeerInterface or tcpInterface, whichever is available
    void SendUnified( const SLNet::BitStream * bitStream, PacketPriority priority, PacketReliability reliability, char orderingChannel, const AddressOrGUID systemIdentifier, bool broadcast );
    void SendUnified( const char * data, const int length, 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_TCPInterface==1
    TCPInterface *tcpInterface;
#endif
};

} // namespace SLNet

#endif