rotor::plugin::resources_plugin_t Struct Reference

"lock" for external resources More...

#include <resources.h>

Inheritance diagram for rotor::plugin::resources_plugin_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.
bool	handle_init (message::init_request_t *message) noexcept override
	polls plugin, whether it is done with initialization
bool	handle_shutdown (message::shutdown_request_t *message) noexcept override
	polls plugin, whether it is done with shutdown
virtual void	acquire (resource_id_t=0) noexcept
	increments the resource counter (aka locks)
virtual bool	release (resource_id_t=0) noexcept
	decrements the resource counter (aka unlocks)
virtual std::uint32_t	has (resource_id_t=0) noexcept
	returns counter value for resource_id
virtual bool	has_any () noexcept
	returns true if there is any resource is locked
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 void	deactivate () noexcept
	deactivates plugin from an actor
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	handle_unsubscription (const subscription_point_t &point, bool external) noexcept
	polls plugin, whether it is done with unsubscription
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_t *	actor
	non-owning actor pointer

Detailed Description

"lock" for external resources

The main purpose of the plugin is to let actor know, that some external resources are acquired, and the actor should will be suspended until they will be released.

The suspension will happen during init and shutdown phases, e.g.:

• actor can wait, until connection will be established
• actor can wait, until it receives handshake from remote system
• etc...

The used resource_id can be anything, which has meaning for an actor. Internally resource_id is just an index in vector, so don't create it too big.

Member Function Documentation

acquire()

virtual void rotor::plugin::resources_plugin_t::acquire ( resource_id_t  = 0 )

virtualnoexcept

increments the resource counter (aka locks)

It will block init/shutdown until the resource be released

activate()

void rotor::plugin::resources_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.

handle_init()

bool rotor::plugin::resources_plugin_t::handle_init ( message::init_request_t *  message )

overridevirtualnoexcept

polls plugin, whether it is done with initialization

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

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

Reimplemented from rotor::plugin::plugin_base_t.

handle_shutdown()

bool rotor::plugin::resources_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.

has()

virtual std::uint32_t rotor::plugin::resources_plugin_t::has ( resource_id_t  = 0 )

virtualnoexcept

returns counter value for resource_id

if the resource was freed, zero is returned

identity()

const std::type_index & rotor::plugin::resources_plugin_t::identity ( ) const

overridevirtualnoexcept

returns pointer, which uniquely identifiess plugin type

Implements rotor::plugin::plugin_base_t.

release()

virtual bool rotor::plugin::resources_plugin_t::release ( resource_id_t  = 0 )

virtualnoexcept

decrements the resource counter (aka unlocks)

If there is no any resource free, the init/shutdown procedure (if it was started) will be continued

Member Data Documentation

class_identity

const std::type_index rotor::plugin::resources_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:

• /home/b/development/cpp/cpp-rotor/include/rotor/plugin/resources.h