xentara::process Namespace Reference

Functionality for accessing and publishing events and tasks. More...

Classes
class	CollatedEventHandler
	An event handler that only gets called once for all events belonging to a single operation. More...
class	Event
	A free-standing event provided by an element. More...
class	EventHandler
	A handler that can be attached to an event. More...
class	ExecutionContext
	An execution context for executing a task. More...
class	ExtendedEvent
	A reference to an event published by a Xentara element, including change events for attributes. More...
class	StageAgnosticTask
	A task that calls operational() for all stages. More...
class	Task
	A task that needs to performed by a plugin. More...
class	TimerSchedule
	Scheduling information for a timer. More...
struct	UnpreparedTag
	Type used to specify that an extended event still needs to be prepared. More...

Typedefs
using	EventList = std::vector< std::reference_wrapper< const Event > >
	Alias for an std::vector of event references.
using	FixedEventList = utils::core::FixedVector< std::reference_wrapper< const Event > >
	Alias for a utils::core::FixedVector of event references.
template<std::size_t kCapacity>
using	StaticEventList = utils::core::StaticVector< std::reference_wrapper< const Event >, kCapacity >
	Alias for a utils::core::StaticVector of event references.

Detailed Description

Functionality for accessing and publishing events and tasks.

This namespace contains functionality for accessing events and tasks of Xentara elements, and for publishing events and tasks of skill elements.

Typedef Documentation

EventList

using xentara::process::EventList = typedef std::vector<std::reference_wrapper<const Event> >

Alias for an std::vector of event references.

This is a convenience type alias, suitable for generating an event list to pass to with [Event::raise()](Event::raise(std::chrono::system_clock::time_point, std::span<std::reference_wrapper<const Event>>)) or WriteSentinel::commit().

Include file

#include <xentara/process/EventList.hpp>

FixedEventList

using xentara::process::FixedEventList = typedef utils::core::FixedVector<std::reference_wrapper<const Event> >

Alias for a utils::core::FixedVector of event references.

This is a convenience type alias, suitable for generating an event list to pass to with [Event::raise()](Event::raise(std::chrono::system_clock::time_point, std::span<std::reference_wrapper<const Event>>)) or WriteSentinel::commit().

Include file

#include <xentara/process/EventList.hpp>

StaticEventList

template<std::size_t kCapacity>

using xentara::process::StaticEventList = typedef utils::core::StaticVector<std::reference_wrapper<const Event>, kCapacity>

Alias for a utils::core::StaticVector of event references.

This is a convenience type alias, suitable for generating an event list to pass to with [Event::raise()](Event::raise(std::chrono::system_clock::time_point, std::span<std::reference_wrapper<const Event>>)) or WriteSentinel::commit().

Include file

#include <xentara/process/EventList.hpp>