IrcErrorCode.hpp

Go to the documentation of this file.

#pragma once
 
#include "Core/AttributeDefines.hpp"
 
/** Tuple of error code, error number, and error message. */
#define IRC_ERROR_CODE_TUPLE_LIST                                                                            \
    IRC_ERROR_CODE_X(IRC_SUCCESS                , 0, "Success")                                              \
    IRC_ERROR_CODE_X(IRC_FAILED_UNREACHABLE_CODE, 5, "Failed to reach the unreachable code")                 \
    IRC_ERROR_CODE_X(IRC_SHUTDOWN               , 6, "Shutdown")                                             \
                                                                                                             \
    /** @name Related CreateServer() */                                                                      \
    /**@{*/                                                                                                  \
    IRC_ERROR_CODE_X(IRC_INVALID_PORT      , 100, "Invalid port number")                                     \
    IRC_ERROR_CODE_X(IRC_PASSWORD_TOO_SHORT, 101, "Password is too short")                                   \
    IRC_ERROR_CODE_X(IRC_PASSWORD_TOO_LONG , 102, "Password is too long")                                    \
    IRC_ERROR_CODE_X(IRC_INVALID_PASSWORD  , 103, "Invalid password")                                        \
    /**@}*/                                                                                                  \
                                                                                                             \
    /** @name Related SocketAPI */                                                                           \
    /**@{*/                                                                                                  \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_CREATE_SOCKET    , 200, "Failed to create socket")                        \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_BIND_SOCKET      , 201, "Failed to bind socket")                          \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_LISTEN_SOCKET    , 202, "Failed to listen on socket")                     \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_ACCEPT_SOCKET    , 203, "Failed to accept on socket")                     \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_CONNECT_SOCKET   , 204, "Failed to connect on socket")                    \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_SEND_SOCKET      , 205, "Failed to send on socket")                       \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_RECV_SOCKET      , 206, "Failed to recv on socket")                       \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_CLOSE_SOCKET     , 207, "Failed to close on socket")                      \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_SHUTDOWN_SOCKET  , 208, "Failed to shutdown on socket")                   \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_SETSOCKOPT_SOCKET, 209, "Failed to setsockopt on socket")                 \
    IRC_ERROR_CODE_X(IRC_ERROR_LISTEN_SOCKET        , 210, "Listen socket error in eventLoop")               \
    /**@}*/                                                                                                  \
                                                                                                             \
    /** @name Related kqueue and kevent */                                                                   \
    /**@{*/                                                                                                  \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_CREATE_KQUEUE  , 300, "Failed to create kqueue")                          \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_ADD_KEVENT     , 301, "Failed to add kqueue")                             \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_DEL_KEVENT     , 302, "Failed to del kqueue")                             \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_WAIT_KEVENT    , 303, "Failed to wait kevent")                            \
    IRC_ERROR_CODE_X(IRC_FAILED_TO_OBSERVE_KEVENT , 304, "Failed to observe kevent")                         \
    IRC_ERROR_CODE_X(IRC_ERROR_LISTEN_SOCKET_EVENT, 305, "Listen socket event error")                        \
    IRC_ERROR_CODE_X(IRC_ERROR_CLIENT_SOCKET_EVENT, 306, "Client socket event error")                        \
    /**@}*/
 
namespace IRC
{
    /** Error Codes Enum */
    typedef enum
    {
#define IRC_ERROR_CODE_X(code, number, message) code = number,
        IRC_ERROR_CODE_TUPLE_LIST
            IRC_ERROR_CODE_MAX
#undef IRC_ERROR_CODE_X
    } EIrcErrorCode;
 
    /** Get the error message from the error code.
     *
     * @param errorCode     Error code.
     * @return const char*  Error message.
     */
    inline const char *GetIrcErrorMessage(const EIrcErrorCode errorCode)
    {
        switch (errorCode)
        {
#define IRC_ERROR_CODE_X(code, number, message) \
    case code:                              \
        return message;
            IRC_ERROR_CODE_TUPLE_LIST
#undef IRC_ERROR_CODE_X
        default:
            return "Unknown error";
        }
    }
}