ITelemetry.h

Go to the documentation of this file.

#ifndef GALAXY_I_TELEMETRY_H
#define GALAXY_I_TELEMETRY_H
 
#include "IListenerRegistrar.h"
 
namespace galaxy
{
    namespace api
    {
        class ITelemetryEventSendListener : public GalaxyTypeAwareListener<TELEMETRY_EVENT_SEND_LISTENER>
        {
        public:
 
            virtual void OnTelemetryEventSendSuccess(const char* eventType, uint32_t sentEventIndex) = 0;
 
            enum FailureReason
            {
                FAILURE_REASON_UNDEFINED, 
                FAILURE_REASON_CLIENT_FORBIDDEN, 
                FAILURE_REASON_INVALID_DATA, 
                FAILURE_REASON_CONNECTION_FAILURE, 
                FAILURE_REASON_NO_SAMPLING_CLASS_IN_CONFIG, 
                FAILURE_REASON_SAMPLING_CLASS_FIELD_MISSING, 
                FAILURE_REASON_EVENT_SAMPLED_OUT, 
                FAILURE_REASON_SAMPLING_RESULT_ALREADY_EXIST, 
                FAILURE_REASON_SAMPLING_INVALID_RESULT_PATH 
            };
 
            virtual void OnTelemetryEventSendFailure(const char* eventType, uint32_t sentEventIndex, FailureReason failureReason) = 0;
        };
 
        typedef SelfRegisteringListener<ITelemetryEventSendListener> GlobalTelemetryEventSendListener;
 
 
        typedef SelfRegisteringListener<ITelemetryEventSendListener, GameServerListenerRegistrar> GameServerGlobalTelemetryEventSendListener;
 
        class ITelemetry
        {
        public:
 
            virtual ~ITelemetry()
            {
            }
 
            virtual void AddStringParam(const char* name, const char* value) = 0;
 
            virtual void AddIntParam(const char* name, int32_t value) = 0;
 
            virtual void AddFloatParam(const char* name, double value) = 0;
 
            virtual void AddBoolParam(const char* name, bool value) = 0;
 
            virtual void AddObjectParam(const char* name) = 0;
 
            virtual void AddArrayParam(const char* name) = 0;
 
            virtual void CloseParam() = 0;
 
            virtual void ClearParams() = 0;
 
 
            virtual void SetSamplingClass(const char* name) = 0;
 
            virtual uint32_t SendTelemetryEvent(const char* eventType, ITelemetryEventSendListener* const listener = NULL) = 0;
 
            virtual uint32_t SendAnonymousTelemetryEvent(const char* eventType, ITelemetryEventSendListener* const listener = NULL) = 0;
 
            virtual const char* GetVisitID() = 0;
 
            virtual void GetVisitIDCopy(char* buffer, uint32_t bufferLength) = 0;
 
            virtual void ResetVisitID() = 0;
        };
 
    }
}
 
#endif