iceoryx_doc  1.0.1
mutex.hpp
1 // Copyright (c) 2019 by Robert Bosch GmbH. All rights reserved.
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 // http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 //
15 // SPDX-License-Identifier: Apache-2.0
16 #ifndef IOX_UTILS_POSIX_WRAPPER_MUTEX_HPP
17 #define IOX_UTILS_POSIX_WRAPPER_MUTEX_HPP
18 
19 #include "iceoryx_utils/cxx/optional.hpp"
20 #include "iceoryx_utils/platform/pthread.hpp"
21 
22 #if defined(__QNX__) || defined(__APPLE__)
23 #define PTHREAD_MUTEX_RECURSIVE_NP PTHREAD_MUTEX_RECURSIVE
24 #define PTHREAD_MUTEX_FAST_NP PTHREAD_MUTEX_NORMAL
25 #endif
26 
27 namespace iox
28 {
29 namespace posix
30 {
55 class mutex
56 {
57  public:
61  mutex(const bool f_isRecursive);
62 
63  ~mutex();
64 
69  mutex(const mutex&) = delete;
70  mutex(mutex&&) = delete;
71  mutex& operator=(const mutex&) = delete;
72  mutex& operator=(mutex&&) = delete;
73 
77  bool lock();
82  bool unlock();
83 
87  bool try_lock();
88 
92  pthread_mutex_t get_native_handle() const noexcept;
93 
94  pthread_mutex_t m_handle;
95 };
96 } // namespace posix
97 } // namespace iox
98 
99 #endif // IOX_UTILS_POSIX_WRAPPER_MUTEX_HPP
building block to easily create free function for logging in a library context
Definition: lockfree_queue.hpp:28