WebSocket++  0.8.3-dev
C++ websocket client/server library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
none.hpp
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 
28 #ifndef WEBSOCKETPP_CONCURRENCY_NONE_HPP
29 #define WEBSOCKETPP_CONCURRENCY_NONE_HPP
30 
31 namespace websocketpp {
32 
33 /// Concurrency handling support
34 namespace concurrency {
35 
36 /// Implementation for no-op locking primitives
37 namespace none_impl {
38 /// A fake mutex implementation that does nothing
39 class fake_mutex {
40 public:
41  fake_mutex() {}
42  ~fake_mutex() {}
43 };
44 
45 /// A fake lock guard implementation that does nothing
47 public:
48  explicit fake_lock_guard(fake_mutex) {}
49  ~fake_lock_guard() {}
50 };
51 } // namespace none_impl
52 
53 /// Stub concurrency policy that implements the interface using no-ops.
54 /**
55  * This policy documents the concurrency policy interface using no-ops. It can
56  * be used as a reference or base for building a new concurrency policy. It can
57  * also be used as is to disable all locking for endpoints used in purely single
58  * threaded programs.
59  */
60 class none {
61 public:
62  /// The type of a mutex primitive
63  /**
64  * std::mutex is an example.
65  */
67 
68  /// The type of a scoped/RAII lock primitive.
69  /**
70  * The scoped lock constructor should take a mutex_type as a parameter,
71  * acquire that lock, and release it in its destructor. std::lock_guard is
72  * an example.
73  */
75 };
76 
77 } // namespace concurrency
78 } // namespace websocketpp
79 
80 #endif // WEBSOCKETPP_CONCURRENCY_ASYNC_HPP
websocketpp::concurrency::none::mutex_type
none_impl::fake_mutex mutex_type
The type of a mutex primitive.
Definition: none.hpp:66
websocketpp::concurrency::none::scoped_lock_type
none_impl::fake_lock_guard scoped_lock_type
The type of a scoped/RAII lock primitive.
Definition: none.hpp:74
websocketpp::concurrency::none_impl::fake_lock_guard
A fake lock guard implementation that does nothing.
Definition: none.hpp:46
websocketpp::versions_supported
static std::vector< int > const versions_supported(helper, helper+4)
Container that stores the list of protocol versions supported.
websocketpp::concurrency::none_impl::fake_mutex
A fake mutex implementation that does nothing.
Definition: none.hpp:39
websocketpp::concurrency::none_impl
Implementation for no-op locking primitives.
Definition: none.hpp:37
websocketpp::concurrency::none
Stub concurrency policy that implements the interface using no-ops.
Definition: none.hpp:60
websocketpp::concurrency
Concurrency handling support.
Definition: basic.hpp:34