MappingEntry

Fully qualified name: carb::events::MappingEntry

Defined in carb/events/IEventsAdapter.h

struct MappingEntry

Structure defining a mapping entry for use with AdapterDesc.

Subclassed by carb::events::MappingEntry2

Public Functions

inline constexpr MappingEntry(

EventType type,

RString dispatchName,

RString pushName = RString(),

) noexcept

Constructor.

Parameters:

• type – The EventType to map.

• dispatchName – The RString to map type to.

• pushName – For AdapterType::eFull adapters, indicates the RString to map type to on the push side.

Public Members

EventType type

An event type. Must be unique across all mappings provided to an AdapterDesc. 0 is a valid EventType and often used for event streams that only push one event type.

RString dispatchName

Name of type for the pop/dispatch side. Required and must be unique across all mappings. Must be unique with respect to pushName if pushName is provided.

RString pushName

Optional name of type for the push side. If empty, no event is dispatched for an event stream’s push() call. An empty RString() is used provide an unspecified push name. Ignored except for AdapterType::eFull.