conduit::Event< Self, Name > Class Template Reference

CRTP library base for conduit events. More...

#include <event.hpp>

Inheritance diagram for conduit::Event< Self, Name >:

Collaboration diagram for conduit::Event< Self, Name >:

Static Public Member Functions
static auto	field_descriptors ()
static parcel::DisplayInfo	display_info ()
	Cell-level descriptive display info.

Static Public Attributes
static constexpr std::string_view	event_name_v = Name.view()
	Bare event name (Name) — used by the bus to key listeners.
static constexpr std::string_view	kind_id = parcel::id_join_v<event_kind_prefix, event_name_v>
	Wire-stable kind id ("conduit:event:" + Name).

Detailed Description

template<typename Self, parcel::FixedString Name>
class conduit::Event< Self, Name >

CRTP library base for conduit events.

Self is the deriving event type (CRTP self); Name is the bare event name (no prefix). The wire kind_id is synthesized as "conduit:event:<Name>"; the bare event name is exposed via event_name_v for bus dispatch.

Each user event must provide:

• static auto& event_field_descriptors(parcel::FieldsBuilder<Self>&) — declares the event's fields.
• a public default constructor (parcel's from_json builds via std::make_shared<Self>()).

Member Function Documentation

display_info()

template<typename Self , parcel::FixedString Name>

static parcel::DisplayInfo conduit::Event< Self, Name >::display_info ( )

inlinestatic

Cell-level descriptive display info.

Defaults to empty; user events may shadow this static to attach name/description for tooling.

field_descriptors()

template<typename Self , parcel::FixedString Name>

static auto conduit::Event< Self, Name >::field_descriptors ( )

inlinestatic

Member Data Documentation

event_name_v

template<typename Self , parcel::FixedString Name>

constexpr std::string_view conduit::Event< Self, Name >::event_name_v = Name.view()

staticconstexpr

Bare event name (Name) — used by the bus to key listeners.

kind_id

template<typename Self , parcel::FixedString Name>

constexpr std::string_view conduit::Event< Self, Name >::kind_id = parcel::id_join_v<event_kind_prefix, event_name_v>

staticconstexpr

Wire-stable kind id ("conduit:event:" + Name).

---

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

• include/conduit/event.hpp