/** * @file include/ActivMiddleware/StatusCodes.h * * @brief Status codes and helper macros. */ #if (!defined ACTIV_STATUS_CODES_H) #define ACTIV_STATUS_CODES_H #include ACTIV_BOOST_INCLUDE(core/scoped_enum.hpp) //! Activ namespace. namespace Activ { //! Return if result of expression tests true using operator against statusCode #define ACTIV_RETURN_IF(statusCode, operator, expression) \ do \ { \ if (expression operator statusCode) \ return; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! Return if result of expression tests true using operator against statusCode1 and statusCode2. #define ACTIV_RETURN_IF_AND_IF(statusCode1, statusCode2, operator, expression) \ do \ { \ const ::Activ::StatusCode thisIsTheResultOfTheCall = expression; \ if ((thisIsTheResultOfTheCall operator statusCode1) && (thisIsTheResultOfTheCall operator statusCode2)) \ return; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! Return result if result of expression tests true using operator against statusCode. #define ACTIV_RETURN_RESULT_IF(statusCode, operator, expression) \ do \ { \ const ::Activ::StatusCode thisIsTheResultOfTheCall = expression; \ if (thisIsTheResultOfTheCall operator statusCode) \ return thisIsTheResultOfTheCall; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! Return result if result of expression tests true using operator against statusCode and assume this is likely. #define ACTIV_RETURN_RESULT_IF_LIKELY(statusCode, operator, expression) \ do \ { \ const ::Activ::StatusCode thisIsTheResultOfTheCall = expression; \ if (ACTIV_LIKELY(thisIsTheResultOfTheCall operator statusCode)) \ return thisIsTheResultOfTheCall; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! Return result if result of expression tests true using operator against statusCode and assume this is unlikely. #define ACTIV_RETURN_RESULT_IF_UNLIKELY(statusCode, operator, expression) \ do \ { \ const ::Activ::StatusCode thisIsTheResultOfTheCall = expression; \ if (ACTIV_UNLIKELY(thisIsTheResultOfTheCall operator statusCode)) \ return thisIsTheResultOfTheCall; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! Return result if result of expression tests true using operator against statusCode1 and statusCode2. #define ACTIV_RETURN_RESULT_IF_AND_IF(statusCode1, statusCode2, operator, expression) \ do \ { \ const ::Activ::StatusCode thisIsTheResultOfTheCall = expression; \ if ((thisIsTheResultOfTheCall operator statusCode1) && (thisIsTheResultOfTheCall operator statusCode2)) \ return thisIsTheResultOfTheCall; \ } \ while (false) // --------------------------------------------------------------------------------------------------------------------------------- //! The list of possible status codes and their string representations. #define ACTIV_STATUS_CODE_LIST(d) \ d(0, SUCCESS, "success") \ d(1, FAILURE, "failure") \ d(2, EXIT, "exit") \ d(3, SHUTTING_DOWN, "shutting down") \ d(4, UNHANDLED_EXCEPTION, "unhandled exception") \ d(5, UNRECOGNIZED, "unrecognized") \ d(6, NOT_FOUND, "not found") \ d(7, TIMEOUT, "timeout") \ d(8, UNCHANGED, "unchanged") \ d(9, PENDING, "pending") \ d(10, ACCESS_DENIED, "access denied") \ d(11, BUFFER_OVERFLOW, "buffer overflow") \ d(12, BUFFER_UNDERRUN, "buffer underrun") \ d(13, NOT_SUPPORTED, "not supported") \ d(14, NOT_INITIALIZED, "not initialized") \ d(15, MISSING_ARGS, "missing args") \ d(16, NOT_OPEN, "not open") \ d(17, ALREADY_OPEN, "already open") \ d(18, DISABLED, "disabled") \ d(19, INVALID_ENDPOINT, "invalid endpoint") \ d(20, INVALID_COMPONENT, "invalid component") \ d(21, INVALID_VERSION, "invalid version") \ d(22, INVALID_LENGTH, "invalid length") \ d(23, INVALID_PARAMETER, "invalid parameter") \ d(24, INVALID_NAME, "invalid name") \ d(25, INVALID_FORMAT, "invalid format") \ d(26, INVALID_INDEX, "invalid index") \ d(27, INVALID_KEY, "invalid key") \ d(28, INVALID_FIELD_TYPE, "invalid field type") \ d(29, INVALID_FIELD, "invalid field") \ d(30, INVALID_RECORD, "invalid record") \ d(31, INVALID_TABLE, "invalid table") \ d(32, INVALID_PROTOCOL, "invalid protocol") \ d(33, UNDEFINED_FIELD, "undefined field") \ d(34, NO_PRIMARY_KEY, "no primary key") \ d(35, MISMATCH, "mismatch") \ d(36, OUT_OF_RANGE, "out of range") \ d(37, STALE, "stale data") \ d(38, DELETED, "item deleted") \ d(39, EMPTY, "empty") \ d(40, FULL, "full") \ d(41, HEAP_EMPTY, "heap empty") \ d(42, WRONG_STATE, "wrong state") \ d(43, NOT_CONNECTED, "not connected") \ d(44, ALREADY_CONNECTED, "already connected") \ d(45, ALREADY_DEFINED, "already defined") \ d(46, NOT_CREATED, "not created") \ d(47, ALREADY_EXISTS, "already exists") \ d(48, IN_USE, "in use") \ d(49, END_OF_DATA, "end of data") \ d(50, ALREADY_LISTENING, "already listening") \ d(51, NOT_SHAREABLE, "not shareable") \ d(52, CONNECTION_REFUSED, "connection refused") \ d(53, INTERRUPTED, "interrupted") \ d(54, IGNORED, "ignored") \ d(55, TOO_MANY_REQUESTS, "too many requests outstanding") \ d(56, INVALID_ENDPOINT_COMPONENT, "invalid endpoint-component") \ d(57, HOST_DEVICE_NOT_FOUND, "host not found") \ d(58, INVALID_USER, "invalid user") \ d(59, INVALID_PASSWORD, "invalid password") \ d(60, INVALID_URL, "invalid url") \ d(61, NOT_A_DIRECTORY, "not a directory") \ d(62, BUSY, "busy") \ d(63, EXPIRED, "expired") \ d(64, HOST_UNREACHABLE, "host unreachable") \ d(65, NETWORK_UNREACHABLE, "network unreachable") \ d(66, NOT_LICENSED, "not licensed") \ d(67, ADDRESS_NOT_AVAILABLE, "address not available") \ d(68, NO_SUCH_DEVICE, "no such device") \ d(69, QUOTA_EXCEEDED, "quota exceeded") \ d(70, INVALID_SERVICE_ID, "invalid service id") \ d(71, PATH_NOT_FOUND, "path not found") \ d(72, INVALID_HANDLE, "invalid handle") \ d(73, INVALID_ADDRESS, "invalid address") \ d(74, INSUFFICIENT_RESOURCES, "insufficient resources") \ d(75, INVALID_REQUEST, "invalid request") \ d(76, NO_PROXY_CONFIGURED, "no proxy configured") \ d(77, MISSING_FIELDS, "missing fields") \ d(78, INVALID_USER_TYPE, "invalid user type") \ d(79, UNDEFINED_LENGTH, "undefined length") \ d(80, FUNCTION_NOT_AVAILABLE, "function not available") \ d(81, CONTINUE, "continue") \ d(82, INVALID_SIGNATURE, "invalid signature") \ d(83, TABLE_NOT_AVAILABLE, "table not available") \ d(84, SOURCE_NOT_FOUND, "source not found") \ d(85, SOURCE_NOT_PERMISSIONED, "source not permissioned") \ d(86, RELATIONSHIP_NOT_FOUND, "relationship not found") \ d(87, RELATIONSHIP_NOT_PERMISSIONED, "relationship not permissioned") \ d(88, NAVIGATION_NOT_FOUND, "navigation not found") \ d(89, NAVIGATION_NOT_PERMISSIONED, "navigation not permissioned") \ d(90, TARGET_NOT_FOUND, "target not found") \ d(91, TARGET_NOT_PERMISSIONED, "target not permissioned") \ d(92, PERMISSION_LEVEL_NOT_AVAILABLE, "permission level not available") \ d(93, SUBSCRIPTION_NOT_AVAILABLE, "subscription not available") \ d(94, INVALID_HOST, "invalid host") \ d(95, REJECTED, "rejected") \ d(96, NO_HEARTBEAT, "no heartbeat") \ d(97, NOT_A_NUMBER, "not a number") \ d(255, UNKNOWN, "unknown") // --------------------------------------------------------------------------------------------------------------------------------- //! Status code type. typedef byte_t StatusCode; //! Macro to declare constant status code. #define ACTIV_DECLARE_STATUS_CODE(value, id, name) const StatusCode ACTIV_JOIN(STATUS_CODE_, id) = value; //! Status code constants. ACTIV_STATUS_CODE_LIST(ACTIV_DECLARE_STATUS_CODE) #undef ACTIV_DECLARE_STATUS_CODE // --------------------------------------------------------------------------------------------------------------------------------- #define ACTIV_DECLARE_STATUS_CODE_ENUM(value, id, name) id = value, //! Scoped enum StatusCodeErrc containing the status codes without STATUS_CODE_ prefix. ACTIV_BOOST_SCOPED_ENUM_UT_DECLARE_BEGIN(StatusCodeErrc, StatusCode) { ACTIV_STATUS_CODE_LIST(ACTIV_DECLARE_STATUS_CODE_ENUM) } ACTIV_BOOST_SCOPED_ENUM_DECLARE_END(StatusCodeErrc) #undef ACTIV_DECLARE_STATUS_CODE_ENUM // --------------------------------------------------------------------------------------------------------------------------------- //! Make a StatusCodeErrc from a plain StatusCode. No checking of valid values. inline StatusCodeErrc MakeStatusCodeErrc(const StatusCode statusCode) { return static_cast(statusCode); } // --------------------------------------------------------------------------------------------------------------------------------- //! Make a StatusCodeErrc from a StatusCodeErrc, for generic code. inline StatusCodeErrc MakeStatusCodeErrc(const StatusCodeErrc statusCode) { return statusCode; } } // namespace Activ #endif // (!defined ACTIV_STATUS_CODES_H)