os-evflags.h

Go to the documentation of this file.

/*
 * This file is part of the µOS++ project (https://micro-os-plus.github.io/).
 * Copyright (c) 2016-2025 Liviu Ionescu. All rights reserved.
 *
 * Permission to use, copy, modify, and/or distribute this software
 * for any purpose is hereby granted, under the terms of the MIT license.
 *
 * If a copy of the license was not distributed with this file, it can
 * be obtained from https://opensource.org/licenses/mit.
 */
 
#ifndef CMSIS_PLUS_RTOS_OS_EVFLAGS_H_
#define CMSIS_PLUS_RTOS_OS_EVFLAGS_H_
 
// ----------------------------------------------------------------------------
 
#if defined(__cplusplus)
 
// ----------------------------------------------------------------------------
 
#if defined(OS_USE_OS_APP_CONFIG_H)
#include <cmsis-plus/os-app-config.h>
#endif
 
#include <cmsis-plus/rtos/os-decls.h>
#include <cmsis-plus/rtos/internal/os-flags.h>
 
// ----------------------------------------------------------------------------
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wc++98-compat"
#endif
 
// ----------------------------------------------------------------------------
 
namespace os
{
  namespace rtos
  {
 
    // ========================================================================
 
#pragma GCC diagnostic push
#if defined(__clang__)
#pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
#pragma GCC diagnostic ignored "-Wpadded"
#endif
 
    class event_flags : public internal::object_named_system
    {
    public:
      // ======================================================================
 
      class attributes : public internal::attributes_clocked
      {
      public:
        constexpr attributes ();
 
        // The rule of five.
        attributes (const attributes&) = default;
        attributes (attributes&&) = default;
        attributes&
        operator= (const attributes&)
            = default;
        attributes&
        operator= (attributes&&)
            = default;
 
        ~attributes () = default;
 
      public:
        // Public members; no accessors and mutators required.
        // Warning: must match the type & order of the C file header.
        // Add more attributes here.
      }; /* class attributes */
 
      static const attributes initializer;
 
      event_flags (const attributes& attr = initializer);
 
      event_flags (const char* name, const attributes& attr = initializer);
 
      // The rule of five.
      event_flags (const event_flags&) = delete;
      event_flags (event_flags&&) = delete;
      event_flags&
      operator= (const event_flags&)
          = delete;
      event_flags&
      operator= (event_flags&&)
          = delete;
 
      ~event_flags ();
 
      bool
      operator== (const event_flags& rhs) const;
 
    public:
      result_t
      wait (flags::mask_t mask, flags::mask_t* oflags,
            flags::mode_t mode = flags::mode::all | flags::mode::clear);
 
      result_t
      try_wait (flags::mask_t mask, flags::mask_t* oflags = nullptr,
                flags::mode_t mode = flags::mode::all | flags::mode::clear);
 
      result_t
      timed_wait (flags::mask_t mask, clock::duration_t timeout,
                  flags::mask_t* oflags = nullptr,
                  flags::mode_t mode = flags::mode::all | flags::mode::clear);
 
      result_t
      raise (flags::mask_t mask, flags::mask_t* oflags = nullptr);
 
      result_t
      clear (flags::mask_t mask, flags::mask_t* oflags = nullptr);
 
      flags::mask_t
      get (flags::mask_t mask, flags::mode_t mode = flags::mode::clear);
 
      bool
      waiting (void);
 
    protected:
#if !defined(OS_USE_RTOS_PORT_EVENT_FLAGS)
      internal::waiting_threads_list list_;
      clock* clock_;
#endif
 
#if defined(OS_USE_RTOS_PORT_EVENT_FLAGS)
      friend class port::event_flags;
      os_evflags_port_data_t port_;
#endif
 
      internal::event_flags event_flags_;
 
    };
 
#pragma GCC diagnostic pop
 
  } /* namespace rtos */
} /* namespace os */
 
// ===== Inline & template implementations ====================================
 
namespace os
{
  namespace rtos
  {
    constexpr event_flags::attributes::attributes ()
    {
    }
 
  } /* namespace rtos */
} /* namespace os */
 
#pragma GCC diagnostic pop
 
// ----------------------------------------------------------------------------
 
#endif /* __cplusplus */
 
// ----------------------------------------------------------------------------
 
#endif /* CMSIS_PLUS_RTOS_OS_EVFLAGS_H_ */