CppUtils::UnitTest::EventWatcher<String::Hasher eventName, class... Args>

Thread-safe RAII observer for monitoring emitted events and collecting payloads.

Description

Subscribes to the designated event upon construction and unsubscribes automatically upon destruction. Provides blocking synchronization utilities (waitForEvent, waitForOccurrences) and thread-safe inspection of occurrence counts and captured payloads.

Guide associé

Consultez la section Guide des tests unitaires pour une explication détaillée et des exemples d’utilisation.

Paramètre template	Description
eventName	Compile-time hashed string identifying the event.
Args	Types of the event payload arguments.

Types publics

Payload

using CppUtils::UnitTest::EventWatcher<eventName, Args>::Payload = std::conditional_t<sizeof...(Args) == 0, std::monostate, std::conditional_t<sizeof...(Args) == 1, std::tuple_element_t<0, std::tuple<Args..., void>>, std::tuple<Args...>>>;

Méthodes publiques

explicit EventWatcher::EventWatcher(auto& emitter);

Subscribes the watcher to the specified event emitter.

Paramètre	Description
emitter	Reference to the event emitter to monitor.

EventWatcher::~EventWatcher();

EventWatcher::EventWatcher(const EventWatcher&) = delete;

EventWatcher& EventWatcher::operator=(const EventWatcher&) = delete;

EventWatcher::EventWatcher(EventWatcher&& other) noexcept;

EventWatcher& EventWatcher::operator=(EventWatcher&& other) noexcept;

[[nodiscard]] auto EventWatcher::count() const noexcept -> std::size_t;

Returns the total number of times the monitored event has been fired.

Retourne : Event occurrence count.

[[nodiscard]] auto EventWatcher::hasOccurred() const noexcept -> bool;

Checks if the monitored event has occurred at least once.

Retourne : True if count() > 0.

template <Chrono::Duration TimeoutDuration = std::chrono::milliseconds>
auto EventWatcher::waitForOccurrences(std::size_t targetCount, TimeoutDuration timeout = std::chrono::milliseconds{1000}) -> bool;

Blocks until the event has been fired at least targetCount times or timeout expires.

Paramètre template	Description
TimeoutDuration	Duration type (defaults to std::chrono::milliseconds).

Paramètre	Description
targetCount	Number of occurrences to wait for.
timeout	Maximum duration to wait before giving up.

Retourne : True if the target occurrence count was reached before the timeout expired.

template <Chrono::Duration TimeoutDuration = std::chrono::milliseconds>
auto EventWatcher::waitForEvent(TimeoutDuration timeout = std::chrono::milliseconds{1000}) -> bool;

Blocks until the event occurs at least once or timeout expires.

Paramètre template	Description
TimeoutDuration	Duration type (defaults to std::chrono::milliseconds).

Paramètre	Description
timeout	Maximum duration to wait before giving up.

Retourne : True if the event occurred before the timeout expired.

[[nodiscard]] auto EventWatcher::occurrences() const -> auto;

Acquires exclusive locked access to the recorded state and payloads.

Guide associé

Consultez la section Guide des tests unitaires pour une explication détaillée et des exemples d’utilisation.

Retourne : Unique accessor locking the internal state.

auto EventWatcher::clear() -> void;

Resets the event occurrence count to zero and clears recorded payloads.