xentara-plugin v2.0.4
The Xentara Plugin Framework
Loading...
Searching...
No Matches
xentara::process Namespace Reference

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  Microservice
 deprecated Deprecated base class for microservice elements More...
 
class  MicroserviceClass
 deprecated Deprecated alias for skill::Element::Class More...
 
class  ServiceProvider
 deprecated Deprecated base class for non-I/O skills 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.
 

Typedef Documentation

◆ EventList

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

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

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>