ManualEvent.hpp

Go to the documentation of this file.

/*
 * Copyright (C) Cross The Road Electronics.  All rights reserved.
 * License information can be found in CTRE_LICENSE.txt
 * For support and suggestions contact support@ctr-electronics.com or file
 * an issue tracker at https://github.com/CrossTheRoadElec/Phoenix-Releases
 */
#pragma once
 
#include "ctre/phoenix/export.h"
#include <array>
#include <condition_variable>
#include <span>
#include <vector>
 
namespace ctre {
namespace phoenix {
namespace threading {
    /**
     * Manual Event object, useful for signaling
     * other threads about an event.
     */
    class CTREXPORT ManualEvent {
    private:
        size_t _signal;
        mutable std::mutex _m;
        mutable std::condition_variable _cv;
        mutable std::vector<ManualEvent *> _anyEvents;
 
    public:
        /**
         * \param initialSignal whether this event defaults to signaled
         */
        ManualEvent(bool initialSignal = false);
 
        /**
         * Wait for event to be signaled, or for timeout.
         * \param timeoutMs timeout of the wait; -1 is indefinite, 0 is a fast check
         * \returns true if event is signaled, false if timed out
         */
        bool WaitForSignal(int timeoutMs) const;
 
        /**
         * Waits for all events to be signaled, or for timeout.
         * \param timeoutMs timeout of the wait; -1 is indefinite, 0 is a fast check
         * \param minTimeoutMs when timeoutMs > 0, minimum amount of time to wait for
         *                     a signal; this can be used to ensure that a non-zero
         *                     timeout is used for every signal; typically 0 or 1 ms
         * \param events comma-separated list of event references to wait on
         * \returns true if all events are signaled, false if timed out
         */
        template <std::same_as<ManualEvent>... Events>
        static bool WaitForAllSignals(int timeoutMs, int minTimeoutMs, Events const &... events)
        {
            return WaitForAllSignals(timeoutMs, minTimeoutMs, std::array<ManualEvent const *, sizeof...(Events)>{(&events)...});
        }
 
        /**
         * Waits for all events to be signaled, or for timeout.
         * \param timeoutMs timeout of the wait; -1 is indefinite, 0 is a fast check
         * \param minTimeoutMs when timeoutMs > 0, minimum amount of time to wait for
         *                     a signal; this can be used to ensure that a non-zero
         *                     timeout is used for every signal; typically 0 or 1 ms
         * \param events a span of event pointers to wait on
         * \returns true if all events are signaled, false if timed out
         */
        static bool WaitForAllSignals(int timeoutMs, int minTimeoutMs, std::span<ManualEvent const* const> events);
 
        /**
         * Waits for any event to be signaled, or for timeout.
         * \param timeoutMs timeout of the wait; -1 is indefinite, 0 is a fast check
         * \param events comma-separated list of event references to wait on
         * \returns true if any event is signaled, false if timed out
         */
        template <std::same_as<ManualEvent>... Events>
        static bool WaitForAnySignal(int timeoutMs, Events const &... events)
        {
            return WaitForAnySignal(timeoutMs, std::array<ManualEvent const *, sizeof...(Events)>{(&events)...});
        }
 
        /**
         * Waits for any event to be signaled, or for timeout.
         * \param timeoutMs timeout of the wait; -1 is indefinite, 0 is a fast check
         * \param events a span of event pointers to wait on
         * \returns true if any event is signaled, false if timed out
         */
        static bool WaitForAnySignal(int timeoutMs, std::span<ManualEvent const* const> events);
 
        /**
         * Signal the event. Any threads waiting on WaitForSignal() will return true.
         */
        void Signal();
        /**
         * Clear the event signal without signaling other threads.
         */
        void Clear();
        /**
         * Reset the event signal to false and force any threads waiting on WaitForSignal() to time out.
         */
        void Reset();
    };
}
}
}