none.hpp 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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_CONCURRENCY_NONE_HPP
  28. #define WEBSOCKETPP_CONCURRENCY_NONE_HPP
  29. namespace websocketpp {
  30. /// Concurrency handling support
  31. namespace concurrency {
  32. /// Implementation for no-op locking primitives
  33. namespace none_impl {
  34. /// A fake mutex implementation that does nothing
  35. class fake_mutex {
  36. public:
  37. fake_mutex() {}
  38. ~fake_mutex() {}
  39. };
  40. /// A fake lock guard implementation that does nothing
  41. class fake_lock_guard {
  42. public:
  43. explicit fake_lock_guard(fake_mutex) {}
  44. ~fake_lock_guard() {}
  45. };
  46. } // namespace none_impl
  47. /// Stub concurrency policy that implements the interface using no-ops.
  48. /**
  49. * This policy documents the concurrency policy interface using no-ops. It can
  50. * be used as a reference or base for building a new concurrency policy. It can
  51. * also be used as is to disable all locking for endpoints used in purely single
  52. * threaded programs.
  53. */
  54. class none {
  55. public:
  56. /// The type of a mutex primitive
  57. /**
  58. * std::mutex is an example.
  59. */
  60. typedef none_impl::fake_mutex mutex_type;
  61. /// The type of a scoped/RAII lock primitive.
  62. /**
  63. * The scoped lock constructor should take a mutex_type as a parameter,
  64. * acquire that lock, and release it in its destructor. std::lock_guard is
  65. * an example.
  66. */
  67. typedef none_impl::fake_lock_guard scoped_lock_type;
  68. };
  69. } // namespace concurrency
  70. } // namespace websocketpp
  71. #endif // WEBSOCKETPP_CONCURRENCY_ASYNC_HPP