so_5::disp_binder_t Class Reference

Interface for dispatcher binders. More...

#include <disp_binder.hpp>

Inheritance diagram for so_5::disp_binder_t:

Public Member Functions
	disp_binder_t ()=default
virtual	~disp_binder_t () noexcept=default
virtual void	preallocate_resources (agent_t &agent)=0
	Allocate resources in dispatcher for new agent.
virtual void	undo_preallocation (agent_t &agent) noexcept=0
	Undo resources allocation.
virtual void	bind (agent_t &agent) noexcept=0
	Bind agent to dispatcher.
virtual void	unbind (agent_t &agent) noexcept=0
	Unbind agent from dispatcher.

Private Member Functions
	disp_binder_t (const disp_binder_t &)=delete
	disp_binder_t (disp_binder_t &&)=delete
disp_binder_t &	operator= (const disp_binder_t &)=delete
disp_binder_t &	operator= (disp_binder_t &&)=delete

Detailed Description

Interface for dispatcher binders.

Dispatcher binders are used in the agent registration process to binding of agents to desired dispatchers.

Attention

If an implementation of disp_binder_t interface stores smart pointers to agents in methods preallocate_resources() and bind() then it must drop (or reset) these stored smart references in undo_preallocation() and unbind() methods. Otherwise there will be circular references between disp_binder and agents and this will lead to memory leaks and other related problems (for example, destructors for agents/disp_binders won't be called).

Definition at line 39 of file disp_binder.hpp.

Constructor & Destructor Documentation

disp_binder_t() [1/3]

so_5::disp_binder_t::disp_binder_t ( const disp_binder_t & )

privatedelete

disp_binder_t() [2/3]

so_5::disp_binder_t::disp_binder_t ( disp_binder_t && )

privatedelete

disp_binder_t() [3/3]

so_5::disp_binder_t::disp_binder_t ( )

default

~disp_binder_t()

virtual so_5::disp_binder_t::~disp_binder_t ( )

virtualdefaultnoexcept

Member Function Documentation

bind()

virtual void so_5::disp_binder_t::bind ( agent_t & agent )

pure virtualnoexcept

Bind agent to dispatcher.

This method will be called after preallocate_resources().

The dispatcher should use resources created during preallocate_resources() call. Because of that this method must not throw.

Parameters

agent

Agent for that previous preallocate_resources() was called.

Implemented in so_5::disp::active_group::impl::actual_binder_t, so_5::disp::active_obj::impl::dispatcher_template_t< Work_Thread >, so_5::disp::adv_thread_pool::impl::actual_binder_t, so_5::disp::nef_one_thread::impl::dispatcher_template_t< Work_Thread >, so_5::disp::nef_thread_pool::impl::actual_binder_t, so_5::disp::one_thread::impl::actual_dispatcher_t< Work_Thread >, so_5::disp::prio_dedicated_threads::one_per_prio::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::quoted_round_robin::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::strictly_ordered::impl::dispatcher_template_t< Work_Thread >, so_5::disp::thread_pool::impl::actual_binder_t, so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Event_Queue_Type >, and so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Activity_Tracker >.

operator=() [1/2]

disp_binder_t & so_5::disp_binder_t::operator= ( const disp_binder_t & )

privatedelete

operator=() [2/2]

disp_binder_t & so_5::disp_binder_t::operator= ( disp_binder_t && )

privatedelete

preallocate_resources()

virtual void so_5::disp_binder_t::preallocate_resources ( agent_t & agent )

pure virtual

Allocate resources in dispatcher for new agent.

This method can and should throw on failure.

Parameters

agent

Agent to be bound.

Implemented in so_5::disp::active_group::impl::actual_binder_t, so_5::disp::active_obj::impl::dispatcher_template_t< Work_Thread >, so_5::disp::adv_thread_pool::impl::actual_binder_t, so_5::disp::nef_one_thread::impl::dispatcher_template_t< Work_Thread >, so_5::disp::nef_thread_pool::impl::actual_binder_t, so_5::disp::one_thread::impl::actual_dispatcher_t< Work_Thread >, so_5::disp::prio_dedicated_threads::one_per_prio::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::quoted_round_robin::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::strictly_ordered::impl::dispatcher_template_t< Work_Thread >, so_5::disp::thread_pool::impl::actual_binder_t, so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Event_Queue_Type >, and so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Activity_Tracker >.

unbind()

virtual void so_5::disp_binder_t::unbind ( agent_t & agent )

pure virtualnoexcept

Unbind agent from dispatcher.

This method will be called after bind() method.

This method can't throw.

Parameters

agent

Agent for that previous bind() was called.

Implemented in so_5::disp::active_group::impl::actual_binder_t, so_5::disp::active_obj::impl::dispatcher_template_t< Work_Thread >, so_5::disp::adv_thread_pool::impl::actual_binder_t, so_5::disp::nef_one_thread::impl::dispatcher_template_t< Work_Thread >, so_5::disp::nef_thread_pool::impl::actual_binder_t, so_5::disp::one_thread::impl::actual_dispatcher_t< Work_Thread >, so_5::disp::prio_dedicated_threads::one_per_prio::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::quoted_round_robin::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::strictly_ordered::impl::dispatcher_template_t< Work_Thread >, so_5::disp::thread_pool::impl::actual_binder_t, so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Event_Queue_Type >, and so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Activity_Tracker >.

undo_preallocation()

virtual void so_5::disp_binder_t::undo_preallocation ( agent_t & agent )

pure virtualnoexcept

Undo resources allocation.

This method will be called after preallocate_resources() if cooperation can't be registered by some reasons.

This method can't throw.

Parameters

agent

Agent for that previous preallocate_resources() was called.

Implemented in so_5::disp::active_group::impl::actual_binder_t, so_5::disp::active_obj::impl::dispatcher_template_t< Work_Thread >, so_5::disp::adv_thread_pool::impl::actual_binder_t, so_5::disp::nef_one_thread::impl::dispatcher_template_t< Work_Thread >, so_5::disp::nef_thread_pool::impl::actual_binder_t, so_5::disp::one_thread::impl::actual_dispatcher_t< Work_Thread >, so_5::disp::prio_dedicated_threads::one_per_prio::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::quoted_round_robin::impl::dispatcher_template_t< Work_Thread >, so_5::disp::prio_one_thread::strictly_ordered::impl::dispatcher_template_t< Work_Thread >, so_5::disp::thread_pool::impl::actual_binder_t, so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Event_Queue_Type >, and so_5::env_infrastructures::st_reusable_stuff::default_dispatcher_basis_t< Activity_Tracker >.

---

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

• disp_binder.hpp