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_MUTEX_H_
#define ETCPAL_CPP_MUTEX_H_
 
#include <stdexcept>
#include "etcpal/cpp/common.h"
#include "etcpal/mutex.h"
 
namespace etcpal
{
 
class Mutex
{
public:
  Mutex();
  ~Mutex();
 
  Mutex(const Mutex& other) = delete;
  Mutex& operator=(const Mutex& other) = delete;
  Mutex(Mutex&& other)                 = delete;
  Mutex& operator=(Mutex&& other) = delete;
 
  bool Lock();
  bool TryLock(int timeout_ms = 0);
  void Unlock();
 
  etcpal_mutex_t& get();
 
private:
  etcpal_mutex_t mutex_{};
};
 
inline Mutex::Mutex()
{
  (void)etcpal_mutex_create(&mutex_);
}
 
inline Mutex::~Mutex()
{
  etcpal_mutex_destroy(&mutex_);
}
 
inline bool Mutex::Lock()
{
  return etcpal_mutex_lock(&mutex_);
}
 
inline bool Mutex::TryLock(int timeout_ms)
{
  return etcpal_mutex_timed_lock(&mutex_, timeout_ms);
}
 
inline void Mutex::Unlock()
{
  etcpal_mutex_unlock(&mutex_);
}
 
inline etcpal_mutex_t& Mutex::get()
{
  return mutex_;
}
 
class MutexGuard
{
public:
  explicit MutexGuard(Mutex& mutex);
  explicit MutexGuard(etcpal_mutex_t& mutex);
  ~MutexGuard();
 
  MutexGuard(const MutexGuard& other) = delete;
  MutexGuard& operator=(const MutexGuard& other) = delete;
  MutexGuard(MutexGuard&& other)                 = delete;
  MutexGuard& operator=(MutexGuard&& other) = delete;
 
private:
  etcpal_mutex_t& mutex_;
 
  void GetLock();
};
 
inline MutexGuard::MutexGuard(Mutex& mutex) : mutex_(mutex.get())
{
  GetLock();
}
 
inline MutexGuard::MutexGuard(etcpal_mutex_t& mutex) : mutex_(mutex)
{
  GetLock();
}
 
inline MutexGuard::~MutexGuard()
{
  etcpal_mutex_unlock(&mutex_);
}
 
inline void MutexGuard::GetLock()
{
  if (!etcpal_mutex_lock(&mutex_))
    ETCPAL_THROW(std::runtime_error("etcpal_mutex_lock failed."));
}
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_MUTEX_H_