extension.hpp 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /*
  2. * Copyright (c) 2014, Peter Thorson. All rights reserved.
  3. *
  4. * Redistribution and use in source and binary forms, with or without
  5. * modification, are permitted provided that the following conditions are met:
  6. * * Redistributions of source code must retain the above copyright
  7. * notice, this list of conditions and the following disclaimer.
  8. * * Redistributions in binary form must reproduce the above copyright
  9. * notice, this list of conditions and the following disclaimer in the
  10. * documentation and/or other materials provided with the distribution.
  11. * * Neither the name of the WebSocket++ Project nor the
  12. * names of its contributors may be used to endorse or promote products
  13. * derived from this software without specific prior written permission.
  14. *
  15. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  16. * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17. * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18. * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
  19. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  20. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  21. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  22. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  24. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25. *
  26. */
  27. #ifndef WEBSOCKETPP_EXTENSION_HPP
  28. #define WEBSOCKETPP_EXTENSION_HPP
  29. #include <websocketpp/common/cpp11.hpp>
  30. #include <websocketpp/common/system_error.hpp>
  31. #include <string>
  32. #include <vector>
  33. namespace websocketpp {
  34. /**
  35. * Some generic information about extensions
  36. *
  37. * Each extension object has an implemented flag. It can be retrieved by calling
  38. * is_implemented(). This compile time flag indicates whether or not the object
  39. * in question actually implements the extension or if it is a placeholder stub
  40. *
  41. * Each extension object also has an enabled flag. It can be retrieved by
  42. * calling is_enabled(). This runtime flag indicates whether or not the
  43. * extension has been negotiated for this connection.
  44. */
  45. namespace extensions {
  46. namespace error {
  47. enum value {
  48. /// Catch all
  49. general = 1,
  50. /// Extension disabled
  51. disabled
  52. };
  53. class category : public lib::error_category {
  54. public:
  55. category() {}
  56. const char *name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
  57. return "websocketpp.extension";
  58. }
  59. std::string message(int value) const {
  60. switch(value) {
  61. case general:
  62. return "Generic extension error";
  63. case disabled:
  64. return "Use of methods from disabled extension";
  65. default:
  66. return "Unknown permessage-compress error";
  67. }
  68. }
  69. };
  70. inline lib::error_category const & get_category() {
  71. static category instance;
  72. return instance;
  73. }
  74. inline lib::error_code make_error_code(error::value e) {
  75. return lib::error_code(static_cast<int>(e), get_category());
  76. }
  77. } // namespace error
  78. } // namespace extensions
  79. } // namespace websocketpp
  80. _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
  81. template<> struct is_error_code_enum
  82. <websocketpp::extensions::error::value>
  83. {
  84. static const bool value = true;
  85. };
  86. _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
  87. #endif // WEBSOCKETPP_EXTENSION_HPP