experimental/status-code/getaddrinfo_code.hpp

0001 /* Proposed SG14 status_code
0002 (C) 2020-2024 Niall Douglas <http://www.nedproductions.biz/> (5 commits)
0003 File Created: Jan 2020
0004
0005
0006 Boost Software License - Version 1.0 - August 17th, 2003
0007
0008 Permission is hereby granted, free of charge, to any person or organization
0009 obtaining a copy of the software and accompanying documentation covered by
0010 this license (the "Software") to use, reproduce, display, distribute,
0011 execute, and transmit the Software, and to prepare derivative works of the
0012 Software, and to permit third-parties to whom the Software is furnished to
0013 do so, all subject to the following:
0014
0015 The copyright notices in the Software and this entire statement, including
0016 the above license grant, this restriction and the following disclaimer,
0017 must be included in all copies of the Software, in whole or in part, and
0018 all derivative works of the Software, unless such copies or derivative
0019 works are solely in the form of machine-executable object code generated by
0020 a source language processor.
0021
0022 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0023 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0024 FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
0025 SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
0026 FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
0027 ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
0028 DEALINGS IN THE SOFTWARE.
0029 */
0030
0031 #ifndef BOOST_OUTCOME_SYSTEM_ERROR2_GETADDRINFO_CODE_HPP
0032 #define BOOST_OUTCOME_SYSTEM_ERROR2_GETADDRINFO_CODE_HPP
0033
0034 #include "quick_status_code_from_enum.hpp"
0035
0036 #ifdef _WIN32
0037 #error Not available for Microsoft Windows
0038 #else
0039 #include <netdb.h>
0040 #include <sys/socket.h>
0041 #include <sys/types.h>
0042 #endif
0043
0044 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_BEGIN
0045
0046 class _getaddrinfo_code_domain;
0047 //! A getaddrinfo error code, those returned by `getaddrinfo()`.
0048 using getaddrinfo_code = status_code<_getaddrinfo_code_domain>;
0049 //! A specialisation of `status_error` for the `getaddrinfo()` error code domain.
0050 using getaddrinfo_error = status_error<_getaddrinfo_code_domain>;
0051
0052 /*! The implementation of the domain for `getaddrinfo()` error codes, those returned by `getaddrinfo()`.
0053  */
0054 class _getaddrinfo_code_domain : public status_code_domain
0055 {
0056   template <class DomainType> friend class status_code;
0057   using _base = status_code_domain;
0058
0059 public:
0060   //! The value type of the `getaddrinfo()` code, which is an `int`
0061   using value_type = int;
0062   using _base::string_ref;
0063
0064   //! Default constructor
0065   constexpr explicit _getaddrinfo_code_domain(typename _base::unique_id_type id = 0x5b24b2de470ff7b6) noexcept
0066       : _base(id)
0067   {
0068   }
0069   _getaddrinfo_code_domain(const _getaddrinfo_code_domain &) = default;
0070   _getaddrinfo_code_domain(_getaddrinfo_code_domain &&) = default;
0071   _getaddrinfo_code_domain &operator=(const _getaddrinfo_code_domain &) = default;
0072   _getaddrinfo_code_domain &operator=(_getaddrinfo_code_domain &&) = default;
0073   ~_getaddrinfo_code_domain() = default;
0074
0075   //! Constexpr singleton getter. Returns constexpr getaddrinfo_code_domain variable.
0076   static inline constexpr const _getaddrinfo_code_domain &get();
0077
0078   virtual string_ref name() const noexcept override { return string_ref("getaddrinfo() domain"); }  // NOLINT
0079
0080   virtual payload_info_t payload_info() const noexcept override
0081   {
0082     return {sizeof(value_type), sizeof(status_code_domain *) + sizeof(value_type),
0083             (alignof(value_type) > alignof(status_code_domain *)) ? alignof(value_type) : alignof(status_code_domain *)};
0084   }
0085
0086 protected:
0087   virtual bool _do_failure(const status_code<void> &code) const noexcept override  // NOLINT
0088   {
0089     assert(code.domain() == *this);                                   // NOLINT
0090     return static_cast<const getaddrinfo_code &>(code).value() != 0;  // NOLINT
0091   }
0092   virtual bool _do_equivalent(const status_code<void> &code1, const status_code<void> &code2) const noexcept override  // NOLINT
0093   {
0094     assert(code1.domain() == *this);                                // NOLINT
0095     const auto &c1 = static_cast<const getaddrinfo_code &>(code1);  // NOLINT
0096     if(code2.domain() == *this)
0097     {
0098       const auto &c2 = static_cast<const getaddrinfo_code &>(code2);  // NOLINT
0099       return c1.value() == c2.value();
0100     }
0101     return false;
0102   }
0103   virtual generic_code _generic_code(const status_code<void> &code) const noexcept override  // NOLINT
0104   {
0105     assert(code.domain() == *this);                               // NOLINT
0106     const auto &c = static_cast<const getaddrinfo_code &>(code);  // NOLINT
0107     switch(c.value())
0108     {
0109 #ifdef EAI_ADDRFAMILY
0110     case EAI_ADDRFAMILY:
0111       return errc::no_such_device_or_address;
0112 #endif
0113     case EAI_FAIL:
0114       return errc::io_error;
0115     case EAI_MEMORY:
0116       return errc::not_enough_memory;
0117 #ifdef EAI_NODATA
0118     case EAI_NODATA:
0119       return errc::no_such_device_or_address;
0120 #endif
0121     case EAI_NONAME:
0122       return errc::no_such_device_or_address;
0123 #ifdef EAI_OVERFLOW
0124     case EAI_OVERFLOW:
0125       return errc::argument_list_too_long;
0126 #endif
0127     case EAI_BADFLAGS:  // fallthrough
0128     case EAI_SERVICE:
0129       return errc::invalid_argument;
0130     case EAI_FAMILY:  // fallthrough
0131     case EAI_SOCKTYPE:
0132       return errc::operation_not_supported;
0133     case EAI_AGAIN:  // fallthrough
0134     case EAI_SYSTEM:
0135       return errc::resource_unavailable_try_again;
0136     default:
0137       return errc::unknown;
0138     }
0139   }
0140   virtual string_ref _do_message(const status_code<void> &code) const noexcept override  // NOLINT
0141   {
0142     assert(code.domain() == *this);                               // NOLINT
0143     const auto &c = static_cast<const getaddrinfo_code &>(code);  // NOLINT
0144     return string_ref(gai_strerror(c.value()));
0145   }
0146 #if defined(_CPPUNWIND) || defined(__EXCEPTIONS) || defined(BOOST_OUTCOME_STANDARDESE_IS_IN_THE_HOUSE)
0147   BOOST_OUTCOME_SYSTEM_ERROR2_NORETURN virtual void _do_throw_exception(const status_code<void> &code) const override  // NOLINT
0148   {
0149     assert(code.domain() == *this);                               // NOLINT
0150     const auto &c = static_cast<const getaddrinfo_code &>(code);  // NOLINT
0151     throw status_error<_getaddrinfo_code_domain>(c);
0152   }
0153 #endif
0154 };
0155 //! A constexpr source variable for the `getaddrinfo()` code domain, which is that of `getaddrinfo()`. Returned by `_getaddrinfo_code_domain::get()`.
0156 constexpr _getaddrinfo_code_domain getaddrinfo_code_domain;
0157 inline constexpr const _getaddrinfo_code_domain &_getaddrinfo_code_domain::get()
0158 {
0159   return getaddrinfo_code_domain;
0160 }
0161
0162 BOOST_OUTCOME_SYSTEM_ERROR2_NAMESPACE_END
0163
0164 #endif