recursive_mutex.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2022 ETC Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *******************************************************************************
 * This file is a part of EtcPal. For more information, go to:
 * https://github.com/ETCLabs/EtcPal
 ******************************************************************************/
 
 
#ifndef ETCPAL_CPP_RECURSIVE_MUTEX_H_
#define ETCPAL_CPP_RECURSIVE_MUTEX_H_
 
#include <stdexcept>
#include "etcpal/cpp/common.h"
#include "etcpal/recursive_mutex.h"
 
namespace etcpal
{
 
class RecursiveMutex
{
public:
  RecursiveMutex();
  ~RecursiveMutex();
 
  RecursiveMutex(const RecursiveMutex& other) = delete;
  RecursiveMutex& operator=(const RecursiveMutex& other) = delete;
  RecursiveMutex(RecursiveMutex&& other)                 = delete;
  RecursiveMutex& operator=(RecursiveMutex&& other) = delete;
 
  bool Lock();
  bool TryLock(int timeout_ms = 0);
  void Unlock();
 
  etcpal_recursive_mutex_t& get();
 
private:
  etcpal_recursive_mutex_t mutex_{};
};
 
inline RecursiveMutex::RecursiveMutex()
{
  (void)etcpal_recursive_mutex_create(&mutex_);
}
 
inline RecursiveMutex::~RecursiveMutex()
{
  etcpal_recursive_mutex_destroy(&mutex_);
}
 
inline bool RecursiveMutex::Lock()
{
  return etcpal_recursive_mutex_lock(&mutex_);
}
 
inline bool RecursiveMutex::TryLock(int timeout_ms)
{
  return etcpal_recursive_mutex_timed_lock(&mutex_, timeout_ms);
}
 
inline void RecursiveMutex::Unlock()
{
  etcpal_recursive_mutex_unlock(&mutex_);
}
 
inline etcpal_recursive_mutex_t& RecursiveMutex::get()
{
  return mutex_;
}
 
class RecursiveMutexGuard
{
public:
  explicit RecursiveMutexGuard(RecursiveMutex& mutex);
  explicit RecursiveMutexGuard(etcpal_recursive_mutex_t& mutex);
  ~RecursiveMutexGuard();
 
  RecursiveMutexGuard(const RecursiveMutexGuard& other) = delete;
  RecursiveMutexGuard& operator=(const RecursiveMutexGuard& other) = delete;
  RecursiveMutexGuard(RecursiveMutexGuard&& other)                 = delete;
  RecursiveMutexGuard& operator=(RecursiveMutexGuard&& other) = delete;
 
private:
  etcpal_recursive_mutex_t& mutex_;
 
  void GetLock();
};
 
inline RecursiveMutexGuard::RecursiveMutexGuard(RecursiveMutex& mutex) : mutex_(mutex.get())
{
  GetLock();
}
 
inline RecursiveMutexGuard::RecursiveMutexGuard(etcpal_recursive_mutex_t& mutex) : mutex_(mutex)
{
  GetLock();
}
 
inline RecursiveMutexGuard::~RecursiveMutexGuard()
{
  etcpal_recursive_mutex_unlock(&mutex_);
}
 
inline void RecursiveMutexGuard::GetLock()
{
  if (!etcpal_recursive_mutex_lock(&mutex_))
    ETCPAL_THROW(std::runtime_error("etcpal_recursive_mutex_lock failed."));
}
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_RECURSIVE_MUTEX_H_