xronos-sdk 0.5.0
Xronos C++ SDK
Loading...
Searching...
No Matches
xronos::sdk::Shutdown Class Referencefinal

A reactor element that emits an event right before the program shuts down. More...

#include <xronos/sdk/shutdown.hh>

Inheritance diagram for xronos::sdk::Shutdown:
[legend]

Public Member Functions

 Shutdown (std::string_view name, ReactorContext context)
 Constructor.
Public Member Functions inherited from xronos::sdk::Element
auto name () const noexcept -> const std::string &
 Get the element's name.
auto fqn () const noexcept -> const std::string &
 Get the element's fully qualified name.
auto add_attribute (std::string_view key, const AttributeValue &value) noexcept -> bool
 Annotate an element with an attribute.
template<std::ranges::input_range R>
requires requires(std::ranges::range_value_t<R> pair) { { pair.first } -> std::convertible_to<std::string_view>; { pair.second } -> std::convertible_to<AttributeValue>; }
auto add_attributes (const R &range) noexcept -> bool
 Annotate an element with multiple attributes.
auto add_attributes (std::initializer_list< std::pair< std::string_view, AttributeValue > > attributes) -> bool
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
virtual ~Element ()=default
 Virtual destructor.

Detailed Description

A reactor element that emits an event right before the program shuts down.

Can be used as a reaction trigger.

Constructor & Destructor Documentation

◆ Shutdown()

xronos::sdk::Shutdown::Shutdown ( std::string_view name,
ReactorContext context )

Constructor.

Typically user code should not need to instantiate this directly, as each reactor provides an instance via Reactor::shutdown().

Parameters
nameThe name of the element.
contextThe containing reactor's context.

The documentation for this class was generated from the following file: