PacketLogger.h

Go to the documentation of this file.

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

#ifndef __PACKET_LOGGER_H
#define __PACKET_LOGGER_H

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

namespace RakNet
{
class RakPeerInterface;


class RAK_DLL_EXPORT PacketLogger : public PluginInterface2
{
public:
    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(PacketLogger)

    PacketLogger();
    virtual ~PacketLogger();

    // Translate the supplied parameters into an output line - overloaded version that takes a MessageIdentifier
    // and translates it into a string (numeric or textual representation based on printId); this calls the
    // second version which takes a const char* argument for the messageIdentifier
    virtual void FormatLine(char* into, const char* dir, const char* type, unsigned int reliableMessageNumber, unsigned int frame
        , unsigned char messageIdentifier, const BitSize_t bitLen, unsigned long long time, const SystemAddress& local, const SystemAddress& remote,
        unsigned int splitPacketId, unsigned int splitPacketIndex, unsigned int splitPacketCount, unsigned int orderingIndex);
    virtual void FormatLine(char* into, const char* dir, const char* type, unsigned int reliableMessageNumber, unsigned int frame
        , const char* idToPrint, const BitSize_t bitLen, unsigned long long time, const SystemAddress& local, const SystemAddress& remote,
        unsigned int splitPacketId, unsigned int splitPacketIndex, unsigned int splitPacketCount, unsigned int orderingIndex);

    virtual void OnDirectSocketSend(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress);
    virtual void OnDirectSocketReceive(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress);
    virtual void OnReliabilityLayerPacketError(const char *errorMessage, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress);
    virtual void OnInternalPacket(InternalPacket *internalPacket, unsigned frameNumber, SystemAddress remoteSystemAddress, RakNet::TimeMS time, int isSend);
    virtual void OnAck(unsigned int messageNumber, SystemAddress remoteSystemAddress, RakNet::TimeMS time);
    virtual void OnPushBackPacket(const char *data, const BitSize_t bitsUsed, SystemAddress remoteSystemAddress);

    virtual void LogHeader(void);

    virtual void WriteLog(const char *str);

    // Write informational messages
    virtual void WriteMiscellaneous(const char *type, const char *msg);


    // Set to true to print ID_* instead of numbers
    virtual void SetPrintID(bool print);
    // Print or hide acks (clears up the screen not to print them but is worse for debugging)
    virtual void SetPrintAcks(bool print);

    virtual void SetPrefix(const char *_prefix);

    virtual void SetSuffix(const char *_suffix);
    static const char* BaseIDTOString(unsigned char Id);

    void SetLogDirectMessages(bool send);
protected:
    const char* IDTOString(unsigned char Id);
    virtual void AddToLog(const char *str);
    // Users should override this
    virtual const char* UserIDTOString(unsigned char Id);
    void GetLocalTime(char buffer[128]);
    bool logDirectMessages;

    bool printId, printAcks;
    char prefix[256];
    char suffix[256];
};

} // namespace RakNet

#endif

#endif // _RAKNET_SUPPORT_*