sem.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_SEM_H_
#define ETCPAL_CPP_SEM_H_
 
#include "etcpal/cpp/common.h"
#include "etcpal/sem.h"
 
namespace etcpal
{
 
class Semaphore
{
public:
  static constexpr unsigned int kDefaultMaxCount = 50;
 
  Semaphore(unsigned int initial_count = 0, unsigned int max_count = kDefaultMaxCount);
  ~Semaphore();
 
  Semaphore(const Semaphore& other) = delete;
  Semaphore& operator=(const Semaphore& other) = delete;
  Semaphore(Semaphore&& other)                 = delete;
  Semaphore& operator=(Semaphore&& other) = delete;
 
  bool Wait();
  bool TryWait(int timeout_ms = 0);
  bool Post();
  bool PostFromIsr();
 
  etcpal_sem_t& get();
 
private:
  etcpal_sem_t sem_{};
};
 
inline Semaphore::Semaphore(unsigned int initial_count, unsigned int max_count)
{
  (void)etcpal_sem_create(&sem_, initial_count, max_count);
}
 
inline Semaphore::~Semaphore()
{
  etcpal_sem_destroy(&sem_);
}
 
inline bool Semaphore::Wait()
{
  return etcpal_sem_wait(&sem_);
}
 
inline bool Semaphore::TryWait(int timeout_ms)
{
  return etcpal_sem_timed_wait(&sem_, timeout_ms);
}
 
inline bool Semaphore::Post()
{
  return etcpal_sem_post(&sem_);
}
 
inline bool Semaphore::PostFromIsr()
{
  return etcpal_sem_post_from_isr(&sem_);
}
 
inline etcpal_sem_t& Semaphore::get()
{
  return sem_;
}
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_SEM_H_