signal.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_SIGNAL_H_
#define ETCPAL_CPP_SIGNAL_H_
 
#include "etcpal/cpp/common.h"
#include "etcpal/signal.h"
 
namespace etcpal
{
 
class Signal
{
public:
  Signal();
  ~Signal();
 
  Signal(const Signal& other) = delete;
  Signal& operator=(const Signal& other) = delete;
  Signal(Signal&& other)                 = delete;
  Signal& operator=(Signal&& other) = delete;
 
  bool Wait();
  bool TryWait(int timeout_ms = 0);
  void Notify();
  void NotifyFromIsr();
 
  etcpal_signal_t& get();
 
private:
  etcpal_signal_t signal_{};
};
 
inline Signal::Signal()
{
  (void)etcpal_signal_create(&signal_);
}
 
inline Signal::~Signal()
{
  etcpal_signal_destroy(&signal_);
}
 
inline bool Signal::Wait()
{
  return etcpal_signal_wait(&signal_);
}
 
inline bool Signal::TryWait(int timeout_ms)
{
  return etcpal_signal_timed_wait(&signal_, timeout_ms);
}
 
inline void Signal::Notify()
{
  etcpal_signal_post(&signal_);
}
 
inline void Signal::NotifyFromIsr()
{
  etcpal_signal_post_from_isr(&signal_);
}
 
inline etcpal_signal_t& Signal::get()
{
  return signal_;
}
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_SIGNAL_H_