event_group.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_EVENT_GROUP_H_
#define ETCPAL_CPP_EVENT_GROUP_H_
 
#include "etcpal/cpp/common.h"
#include "etcpal/event_group.h"
 
namespace etcpal
{
 
using EventBits = etcpal_event_bits_t;
 
class EventGroup
{
public:
  EventGroup();
  ~EventGroup();
 
  EventGroup(const EventGroup& other) = delete;
  EventGroup& operator=(const EventGroup& other) = delete;
  EventGroup(EventGroup&& other)                 = delete;
  EventGroup& operator=(EventGroup&& other) = delete;
 
  EventBits Wait(EventBits bits, int flags = 0);
  EventBits TryWait(EventBits bits, int flags = 0, int timeout_ms = 0);
  void      SetBits(EventBits bits_to_set);
  EventBits GetBits();
  void      ClearBits(EventBits bits_to_clear);
  void      SetBitsFromIsr(EventBits bits_to_set);
  EventBits GetBitsFromIsr();
  void      ClearBitsFromIsr(EventBits bits_to_clear);
 
  etcpal_event_group_t& get();
 
private:
  etcpal_event_group_t event_group_{};
};
 
inline EventGroup::EventGroup()
{
  (void)etcpal_event_group_create(&event_group_);
}
 
inline EventGroup::~EventGroup()
{
  etcpal_event_group_destroy(&event_group_);
}
 
inline EventBits EventGroup::Wait(EventBits bits, int flags)
{
  return etcpal_event_group_wait(&event_group_, bits, flags);
}
 
inline EventBits EventGroup::TryWait(EventBits bits, int flags, int timeout_ms)
{
  return etcpal_event_group_timed_wait(&event_group_, bits, flags, timeout_ms);
}
 
inline void EventGroup::SetBits(EventBits bits_to_set)
{
  etcpal_event_group_set_bits(&event_group_, bits_to_set);
}
 
inline EventBits EventGroup::GetBits()
{
  return etcpal_event_group_get_bits(&event_group_);
}
 
inline void EventGroup::ClearBits(EventBits bits_to_clear)
{
  etcpal_event_group_clear_bits(&event_group_, bits_to_clear);
}
 
inline void EventGroup::SetBitsFromIsr(EventBits bits_to_set)
{
  etcpal_event_group_set_bits_from_isr(&event_group_, bits_to_set);
}
 
inline EventBits EventGroup::GetBitsFromIsr()
{
  return etcpal_event_group_get_bits_from_isr(&event_group_);
}
 
inline void EventGroup::ClearBitsFromIsr(EventBits bits_to_clear)
{
  etcpal_event_group_clear_bits_from_isr(&event_group_, bits_to_clear);
}
 
inline etcpal_event_group_t& EventGroup::get()
{
  return event_group_;
}
 
};  // namespace etcpal
 
#endif  // ETCPAL_CPP_EVENT_GROUP_H_