errortypes.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/coretypes.h"
#include "twitchsdk/core/assertion.h"
#include <functional>
#include <vector>

const uint32_t TTV_MODULE_ID_TWITCH_CORE = 0;

typedef uint32_t TTV_ErrorCode;

const uint32_t kErrorModuleIdMask = 0x7FFF;
const uint32_t kErrorIdMask = 0xFFFF;
const uint32_t kErrorFlagMask = 0x80000000;

#define CONSTRUCT_ERROR_ID_VALUE(MODULE_ID, ERROR_ID)       ( (1U << 31) | ( (MODULE_ID & kErrorModuleIdMask) << 16) | (ERROR_ID & kErrorIdMask) )

#define CONSTRUCT_WARNING_ID_VALUE(MODULE_ID, ERROR_ID)     ( (0U << 31) | ( (MODULE_ID & kErrorModuleIdMask) << 16) | (ERROR_ID & kErrorIdMask) )

#define GET_MODULE_ID(ec)                                   ( (ec >> 16) & kErrorModuleIdMask )

#define GET_ERROR_ID(ec)                                    ( ec & kErrorIdMask )


namespace ttv
{
    struct EnumValue;

    typedef const char* (*ErrorToStringFunction) (TTV_ErrorCode ec);
    typedef void (*ErrorCodeValueFunction) (std::vector<EnumValue>& result);
    void RegisterErrorToStringFunction(ErrorToStringFunction func);
    void UnregisterErrorToStringFunction(ErrorToStringFunction func);
    void RegisterErrorCodeValueFunction(ErrorCodeValueFunction func);
    void UnregisterErrorCodeValueFunction(ErrorCodeValueFunction func);
}


#define TTV_CORE_ERROR_IDS\
    /* Warnings */\
    BEGIN_WARNING_IDS(TTV_WRN_BEGIN_WARNINGS)\
    USE_TTV_WARNING_ID(TTV_WRN_MUTEX_LOCKED)\
    USE_TTV_WARNING_ID(TTV_WRN_NOTENOUGHDATA)\
    USE_TTV_WARNING_ID(TTV_WRN_MUTEX_NOT_ACQUIRED)\
    USE_TTV_WARNING_ID(TTV_WRN_CONDITION_WAIT_FAILED)\
    USE_TTV_WARNING_ID(TTV_WRN_DEPRECATED)\
    USE_TTV_WARNING_ID(TTV_WRN_WAIT_TIMEOUT)                            \
    USE_TTV_WARNING_ID(TTV_WRN_OAUTH_SCOPES_MISSING)\
    END_WARNING_IDS(TTV_WRN_END_WARNINGS)\
    \
    /* Success */\
    USE_TTV_SUCCESS_ID(TTV_EC_SUCCESS)\
    \
    /* Errors */\
    BEGIN_ERROR_IDS(TTV_EC_BEGIN_ERRORS)\
    USE_TTV_ERROR_ID(TTV_EC_UNKNOWN_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_OPEN_FILE)\
    USE_TTV_ERROR_ID(TTV_EC_ALREADY_INITIALIZED)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_WRITE_TO_FILE)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_CREATE_MUTEX)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_DESTROY_MUTEX)\
    USE_TTV_ERROR_ID(TTV_EC_COULD_NOT_TAKE_MUTEX)\
    USE_TTV_ERROR_ID(TTV_EC_COULD_NOT_RELEASE_MUTEX)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_MUTEX)\
    USE_TTV_ERROR_ID(TTV_EC_WAIT_TIMED_OUT)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_ARG)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_FORMAT)\
    USE_TTV_ERROR_ID(TTV_EC_NOT_INITIALIZED)\
    USE_TTV_ERROR_ID(TTV_EC_AUTHENTICATION)\
    USE_TTV_ERROR_ID(TTV_EC_FORBIDDEN)\
    USE_TTV_ERROR_ID(TTV_EC_OAUTHTOKEN_MISSING_SCOPES)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_OAUTHTOKEN)\
    USE_TTV_ERROR_ID(TTV_EC_USERINFO_NOT_AVAILABLE)\
    USE_TTV_ERROR_ID(TTV_EC_NOT_AVAILABLE)\
    USE_TTV_ERROR_ID(TTV_EC_PARAMETERS_CHANGED)\
    USE_TTV_ERROR_ID(TTV_EC_MEMORY)\
    USE_TTV_ERROR_ID(TTV_EC_ALIGN16_REQUIRED)\
    USE_TTV_ERROR_ID(TTV_EC_HTTPREQUEST_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_RATE_LIMITED)\
    USE_TTV_ERROR_ID(TTV_EC_NO_FACTORIES_REGISTERED)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_CLIENTID)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_CHANNEL_ID)\
    USE_TTV_ERROR_ID(TTV_EC_API_REQUEST_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_API_REQUEST_TIMEDOUT)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_HTTP_REQUEST_PARAMS)\
    USE_TTV_ERROR_ID(TTV_EC_COINITIALIZE_FAIED)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_INVALID_JSON)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_AUTHTOKEN)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_STREAMKEY)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_CHANNELNAME)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_INGESTS)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_RECORDING_STATUS)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_STREAMINFO)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_INVALID_VIEWERS)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_USERNAME)\
    USE_TTV_ERROR_ID(TTV_EC_WEBAPI_RESULT_NO_USER_DISPLAY_NAME)\
    USE_TTV_ERROR_ID(TTV_EC_NEED_TO_LOGIN)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_LOGIN)                      \
    USE_TTV_ERROR_ID(TTV_EC_INVALID_USERID)                     \
    USE_TTV_ERROR_ID(TTV_EC_INVALID_BUFFER)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_CALLBACK)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_JSON)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_STATE)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_SUSPEND_THREADSYNC)\
    USE_TTV_ERROR_ID(TTV_EC_CANNOT_SIGNAL_THREADSYNC)\
    USE_TTV_ERROR_ID(TTV_EC_REQUEST_TIMEDOUT)\
    USE_TTV_ERROR_ID(TTV_EC_REQUEST_PENDING)\
    /*****************************/\
    USE_TTV_ERROR_ID(TTV_EC_OS_TOO_OLD)\
    USE_TTV_ERROR_ID(TTV_EC_SHUTTING_DOWN)\
    USE_TTV_ERROR_ID(TTV_EC_SHUT_DOWN)\
    USE_TTV_ERROR_ID(TTV_EC_UNIMPLEMENTED)\
    USE_TTV_ERROR_ID(TTV_EC_ALREADY_LOGGED_IN)\
    USE_TTV_ERROR_ID(TTV_EC_ALREADY_CACHED)\
    USE_TTV_ERROR_ID(TTV_EC_FEATURE_DISABLED)\
    USE_TTV_ERROR_ID(TTV_EC_UNSUPPORTED)\
    USE_TTV_ERROR_ID(TTV_EC_INVALID_INSTANCE)\
    /* Socket errors */\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_EWOULDBLOCK)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_ENOTCONN)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_TRY_AGAIN)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_CONNECT_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_ECONNABORTED)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_EALREADY)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_CREATE_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_GETADDRINFO_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_HOST_NOT_FOUND)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_RECV_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_SEND_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_IOCTL_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_ETIMEDOUT)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_ECONNRESET)\
    USE_TTV_ERROR_ID(TTV_EC_SOCKET_ERR)\
    /*****************************/\
    USE_TTV_ERROR_ID(TTV_EC_PUBSUB_BAD_TOPIC)\
    USE_TTV_ERROR_ID(TTV_EC_PUBSUB_BAD_MESSAGE)\
    USE_TTV_ERROR_ID(TTV_EC_PUBSUB_SERVER_INTERNAL_ERROR)\
    USE_TTV_ERROR_ID(TTV_EC_PUBSUB_RESPONSE_ERROR)\
    /*****************************/\
    USE_TTV_ERROR_ID(TTV_EC_PROFILEIMAGE_IMAGE_VALIDATION_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_PROFILEIMAGE_FORMAT_VALIDATION_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_PROFILEIMAGE_SIZE_VALIDATION_FAILED)\
    USE_TTV_ERROR_ID(TTV_EC_PROFILEIMAGE_BACKEND_FAILURE)\
    /*****************************/\
    USE_TTV_ERROR_ID(TTV_EC_GRAPHQL_ERROR)\
    \
    USE_TTV_ERROR_ID(TTV_EC_INVALID_STRUCT_SIZE)        \
    USE_TTV_ERROR_ID(TTV_EC_REQUEST_ABORTED)            \
    USE_TTV_ERROR_ID(TTV_EC_STILL_IN_USE)               \
    END_ERROR_IDS(TTV_EC_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_CORE, (1 << 12)),
#define END_WARNING_IDS(ec) ec,
#define BEGIN_ERROR_IDS(ec) ec = CONSTRUCT_ERROR_ID_VALUE(TTV_MODULE_ID_TWITCH_CORE, 1),
#define END_ERROR_IDS(ec) ec

typedef enum
{
    TTV_CORE_ERROR_IDS

} TTV_CoreErrorId;

#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


#define TTV_SUCCEEDED(ec) ( (ec & kErrorFlagMask) == 0 )

#define TTV_FAILED(ec) ( (ec & kErrorFlagMask) != 0 )

#define ASSERT_ON_ERROR(ec) { assert ( TTV_SUCCEEDED(ec) ); }
#define RETURN_CLIENT_ERROR(ec) { return ec; }
#define TTV_RETURN_ON_NULL(ptr, ec) { if ( (ptr) == nullptr) RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_NOT_NULL(ptr, ec) { if ( (ptr) != nullptr) RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_EMPTY_STRING(str, ec) { if (str == nullptr || str[0] == '\0') RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_EMPTY_STDSTRING(str, ec) { if (str.size() == 0) RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_ERROR(err) { if (TTV_FAILED(ec)) RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_DIFFERENT(a, b, ec) { if ( (a) != (b) ) RETURN_CLIENT_ERROR(ec); }
#define TTV_RETURN_ON_SAME(a, b, ec) { if ( (a) == (b) ) RETURN_CLIENT_ERROR(ec); }


namespace ttv
{
    const char* ErrorToString(TTV_ErrorCode ec);

    const char* CoreErrorToString(TTV_ErrorCode ec);

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

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


struct ttv::EnumValue
{
    std::string name;
    uint32_t value;

    EnumValue(const char* name, uint32_t value);
};