minimal_client.hpp 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172
  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_CONFIG_MINIMAL_CLIENT_HPP
  28. #define WEBSOCKETPP_CONFIG_MINIMAL_CLIENT_HPP
  29. #include <websocketpp/config/minimal_server.hpp>
  30. namespace websocketpp {
  31. namespace config {
  32. /// Client config with minimal dependencies
  33. /**
  34. * This config strips out as many dependencies as possible. It is suitable for
  35. * use as a base class for custom configs that want to implement or choose their
  36. * own policies for components that even the core config includes.
  37. *
  38. * NOTE: this config stubs out enough that it cannot be used directly. You must
  39. * supply at least a transport policy and a cryptographically secure random
  40. * number generation policy for a config based on `minimal_client` to do
  41. * anything useful.
  42. *
  43. * Present dependency list for minimal_server config:
  44. *
  45. * C++98 STL:
  46. * <algorithm>
  47. * <map>
  48. * <sstream>
  49. * <string>
  50. * <vector>
  51. *
  52. * C++11 STL or Boost
  53. * <memory>
  54. * <functional>
  55. * <system_error>
  56. *
  57. * Operating System:
  58. * <stdint.h> or <boost/cstdint.hpp>
  59. * <netinet/in.h> or <winsock2.h> (for ntohl.. could potentially bundle this)
  60. *
  61. * @since 0.4.0-dev
  62. */
  63. typedef minimal_server minimal_client;
  64. } // namespace config
  65. } // namespace websocketpp
  66. #endif // WEBSOCKETPP_CONFIG_MINIMAL_CLIENT_HPP