trackingerrortypes.h

Go to the documentation of this file.

/********************************************************************************************
* Twitch Broadcasting SDK
*
* This software is supplied under the terms of a license agreement with Twitch Interactive, Inc. and
* may not be copied or used except in accordance with the terms of that agreement
* Copyright (c) 2012-2016 Twitch Interactive, Inc.
*********************************************************************************************/

#pragma once

#include "twitchsdk/core/types/errortypes.h"
#include <vector>

const uint32_t TTV_MODULE_ID_TWITCH_TRACKING = 5;

// NOTE: There are currently no custom error ids
#define TTV_TRACKING_ERROR_IDS\
    BEGIN_WARNING_IDS(TTV_WRN_TRACKING_BEGIN_WARNINGS)\
    END_WARNING_IDS(TTV_WRN_TRACKING_END_WARNINGS)\
    BEGIN_ERROR_IDS(TTV_EC_TRACKING_BEGIN_ERRORS)\
    END_ERROR_IDS(TTV_EC_TRACKING_END_ERRORS)\

#define USE_TTV_ERROR_ID(ec) ec,
#define USE_TTV_WARNING_ID(ec) ec,
#define USE_TTV_SUCCESS_ID(ec) ec = 0,
#define BEGIN_WARNING_IDS(ec) ec = CONSTRUCT_WARNING_ID_VALUE(TTV_MODULE_ID_TWITCH_TRACKING, -1000),
#define END_WARNING_IDS(ec) ec,
#define BEGIN_ERROR_IDS(ec) ec = CONSTRUCT_ERROR_ID_VALUE(TTV_MODULE_ID_TWITCH_TRACKING, 1),
#define END_ERROR_IDS(ec) ec

typedef enum
{
    TTV_TRACKING_ERROR_IDS

} TTV_TrackingErrorId;

#undef BEGIN_ERROR_IDS
#undef END_ERROR_IDS
#undef BEGIN_WARNING_IDS
#undef END_WARNING_IDS
#undef USE_TTV_SUCCESS_ID
#undef USE_TTV_WARNING_ID
#undef USE_TTV_ERROR_ID


namespace ttv
{
    namespace tracking
    {
        inline TTV_ErrorCode ToErrorCode(TTV_TrackingErrorId errorId) 
        { 
            if (errorId <= TTV_WRN_TRACKING_END_WARNINGS)
            {
                return CONSTRUCT_WARNING_ID_VALUE(TTV_MODULE_ID_TWITCH_TRACKING, errorId);
            }
            else
            {
                return CONSTRUCT_ERROR_ID_VALUE(TTV_MODULE_ID_TWITCH_TRACKING, errorId);
            }
        }

        const char* TrackingErrorToString(TTV_ErrorCode ec);

        void GetTrackingErrorCodeValues(std::vector<EnumValue>& result);
    }
}