rotor
Event loop friendly C++ actor micro-framework
 
Loading...
Searching...
No Matches
rotor::plugin::lifetime_plugin_t Struct Reference

manages all actor subscriptions (i.e. from plugins or actor itself). More...

#include <lifetime.h>

Inheritance diagram for rotor::plugin::lifetime_plugin_t:
rotor::plugin::plugin_base_t

Public Member Functions

const std::type_index & identity () const noexcept override
 returns pointer, which uniquely identifiess plugin type
 
void activate (actor_base_t *actor) noexcept override
 invoked by actor upon initialization.
 
void deactivate () noexcept override
 deactivates plugin from an actor
 
void initate_subscription (const subscription_info_ptr_t &info) noexcept
 records initial subscription information
 
void unsubscribe (const handler_ptr_t &h, const address_ptr_t &addr) noexcept
 alias for unsubscription trigger (see below)
 
void unsubscribe (const subscription_info_ptr_t &info) noexcept
 triggers unsubscription
 
virtual void on_subscription (message::subscription_t &) noexcept
 reaction on subscription
 
virtual void on_unsubscription (message::unsubscription_t &) noexcept
 reaction on unsubscription
 
virtual void on_unsubscription_external (message::unsubscription_external_t &) noexcept
 reaction on external unsubscription
 
bool handle_unsubscription (const subscription_point_t &point, bool external) noexcept override
 polls plugin, whether it is done with unsubscription
 
bool handle_shutdown (message::shutdown_request_t *message) noexcept override
 polls plugin, whether it is done with shutdown
 
template<typename T >
auto & access () noexcept
 generic non-public fields accessor
 
 plugin_base_t ()=default
 default plugin ctor
 
 plugin_base_t (const plugin_base_t &)=delete
 copy ctor is not allowed
 
- Public Member Functions inherited from rotor::plugin::plugin_base_t
 plugin_base_t ()=default
 default plugin ctor
 
 plugin_base_t (const plugin_base_t &)=delete
 copy ctor is not allowed
 
virtual bool handle_init (message::init_request_t *message) noexcept
 polls plugin, whether it is done with initialization
 
virtual void handle_start (message::start_trigger_t *message) noexcept
 polls plugin, whether it is done with start
 
virtual bool handle_subscription (message::subscription_t &message) noexcept
 polls plugin, whether it is done with subscription
 
virtual bool forget_subscription (const subscription_point_t &point) noexcept
 remove subscription point from internal storage
 
virtual void forget_subscription (const subscription_info_ptr_t &info) noexcept
 commits unsubscription via supervisor
 
template<typename Plugin , typename Fn >
void with_casted (Fn &&fn, config_phase_t desired_phase=config_phase_t::INITIALIZING) noexcept
 invokes the callback if plugin type and phase mach
 
reaction_underlying_t get_reaction () const noexcept
 returns the current set of plugin reactions
 
void reaction_on (reaction_t value) noexcept
 turns on the specified reaction of the plugin
 
void reaction_off (reaction_t value) noexcept
 turns off the specified reaction of the plugin
 
template<typename T >
auto & access () noexcept
 generic non-public fields accessor
 

Static Public Attributes

static const std::type_index class_identity
 
- Static Public Attributes inherited from rotor::plugin::plugin_base_t
static constexpr reaction_underlying_t REACTION_MASK = 0b00001111
 the bit mask for all reactions enabled
 

Additional Inherited Members

- Public Types inherited from rotor::plugin::plugin_base_t
enum  reaction_t : unsigned { INIT = 0b00000001 , SHUTDOWN = 0b00000010 , SUBSCRIPTION = 0b00000100 , START = 0b00001000 }
 possible plugin's reactions on actor lifetime events
 
using reaction_underlying_t = std::underlying_type_t< reaction_t >
 the underlying type of reaction_t
 
- Protected Member Functions inherited from rotor::plugin::plugin_base_t
template<typename Handler >
subscription_info_ptr_t subscribe (Handler &&handler, const address_ptr_t &address) noexcept
 subscribes plugin to the custom plugin handler on the specified address
 
template<typename Handler >
subscription_info_ptr_t subscribe (Handler &&handler) noexcept
 subscribes plugin to the custom plugin handler on the main actor address
 
extended_error_ptr_t make_error (const std::error_code &ec, const extended_error_ptr_t &next={}, const message_ptr_t &request={}) noexcept
 makes an error within the context of actor
 
- Protected Attributes inherited from rotor::plugin::plugin_base_t
actor_base_tactor
 non-owning actor pointer
 

Detailed Description

manages all actor subscriptions (i.e. from plugins or actor itself).

The plugin main focus to properly cancel subscriptions, i.e. every address where an actor plugin or the actor itself was subscribscribed to.

Member Function Documentation

◆ activate()

void rotor::plugin::lifetime_plugin_t::activate ( actor_base_t actor)
overridevirtualnoexcept

invoked by actor upon initialization.

It it responsible for setting up reactions and further installation, e.g. messages subscriptions and may calling back actor's configuration (which can be postponed).

Before the activate is invoked, the plugin is in PREINIT phase, after the activate is called, the plugin is in INITIALIZING phase. This might be useful for early/late (double) plugin configuration in actor.

Reimplemented from rotor::plugin::plugin_base_t.

◆ deactivate()

void rotor::plugin::lifetime_plugin_t::deactivate ( )
overridevirtualnoexcept

deactivates plugin from an actor

The method can be intercepted by descendants to do not deactivate too early, and called when needed.

The plugin_base_t implementation unsubscribes from all plugin subscriptions and when no subscription left commits deactivation to an actor.

Reimplemented from rotor::plugin::plugin_base_t.

◆ handle_shutdown()

bool rotor::plugin::lifetime_plugin_t::handle_shutdown ( message::shutdown_request_t message)
overridevirtualnoexcept

polls plugin, whether it is done with shutdown

The method is invoked only when shutdown reaction was set on.

The true is returned, that means plugin is done with shutdown and will not be longer polled in future.

Reimplemented from rotor::plugin::plugin_base_t.

◆ handle_unsubscription()

bool rotor::plugin::lifetime_plugin_t::handle_unsubscription ( const subscription_point_t point,
bool  external 
)
overridevirtualnoexcept

polls plugin, whether it is done with unsubscription

All plugins are polled for unsubscription, no special handling is needed unless you know what your are doing.

The true is returned, that means plugin is done with unsubscription and will not be longer polled in future. The default is false.

Reimplemented from rotor::plugin::plugin_base_t.

◆ identity()

const std::type_index & rotor::plugin::lifetime_plugin_t::identity ( ) const
overridevirtualnoexcept

returns pointer, which uniquely identifiess plugin type

Implements rotor::plugin::plugin_base_t.

◆ on_subscription()

virtual void rotor::plugin::lifetime_plugin_t::on_subscription ( message::subscription_t )
virtualnoexcept

reaction on subscription

It just forwards it to the actor to poll related plugins

◆ on_unsubscription()

virtual void rotor::plugin::lifetime_plugin_t::on_unsubscription ( message::unsubscription_t )
virtualnoexcept

reaction on unsubscription

It just forwards it to the actor to poll related plugins

◆ on_unsubscription_external()

virtual void rotor::plugin::lifetime_plugin_t::on_unsubscription_external ( message::unsubscription_external_t )
virtualnoexcept

reaction on external unsubscription

It just forwards it to the actor to poll related plugins

◆ unsubscribe()

void rotor::plugin::lifetime_plugin_t::unsubscribe ( const subscription_info_ptr_t info)
noexcept

triggers unsubscription

For internal subscriptions it answers with unsubscription confirmation; for foreign subscription it sends external unsubscription request

Member Data Documentation

◆ class_identity

const std::type_index rotor::plugin::lifetime_plugin_t::class_identity
static

The plugin unique identity to allow further static_cast'ing


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