so_5::details::event_subscription_helpers Namespace Reference

Various helpers for event subscription. More...

Classes
struct	event_handler_arg_maker
	A helper template for create an argument for event handler in the case when argument is passed as value or const reference. More...
struct	event_handler_arg_maker< immutable_msg< Msg > >
struct	event_handler_arg_maker< mhood_t< immutable_msg< Msg > > >
	A helper template for create an argument for event handler in the case when argument is passed as message hood. More...
struct	event_handler_arg_maker< mhood_t< Msg > >
	A helper template for create an argument for event handler in the case when argument is passed as message hood. More...
struct	event_handler_arg_maker< mhood_t< mutable_msg< Msg > > >
	A helper template for create an argument for event handler in the case when argument is passed as message hood. More...
struct	event_handler_arg_maker< mutable_msg< Msg > >

Functions
template<class Agent >
Agent *	get_actual_agent_pointer (agent_t &agent)
	Get actual agent pointer.
template<typename Handler_Type , typename Result , typename Arg >
msg_type_and_handler_pair_t	make_handler_with_arg (Handler_Type lambda)
	Helper template for creation of event handler with actual argument.
template<class Lambda >
details::msg_type_and_handler_pair_t	make_handler_from_lambda_of_free_function (Lambda &&lambda)
	A function for creation event handler.
template<typename Agent , typename Method_Pointer >
std::enable_if< is_agent_method_pointer< method_arity::unary, Method_Pointer >::value, msg_type_and_handler_pair_t >::type	make_handler_with_arg_for_agent (Agent *agent, Method_Pointer pfn)
	Helper template for creation of event handler with actual argument.
void	ensure_handler_can_be_used_with_mbox (const ::so_5::details::msg_type_and_handler_pair_t &handler, const ::so_5::mbox_t &target_mbox)
	Ensure that mutability of message is compatible with mutability of target mbox.

Detailed Description

Various helpers for event subscription.

Since

v.5.3.0

Function Documentation

ensure_handler_can_be_used_with_mbox()

void so_5::details::event_subscription_helpers::ensure_handler_can_be_used_with_mbox ( const ::so_5::details::msg_type_and_handler_pair_t & handler, const ::so_5::mbox_t & target_mbox )

inline

Ensure that mutability of message is compatible with mutability of target mbox.

Since

v.5.5.21

Definition at line 304 of file handler_makers.hpp.

get_actual_agent_pointer()

template<class Agent >

Agent * so_5::details::event_subscription_helpers::get_actual_agent_pointer

(

agent_t &

agent

)

Get actual agent pointer.

Exceptions

exception_t

if dynamic_cast fails.

Definition at line 52 of file handler_makers.hpp.

make_handler_from_lambda_of_free_function()

template<class Lambda >

details::msg_type_and_handler_pair_t so_5::details::event_subscription_helpers::make_handler_from_lambda_of_free_function

(

Lambda &&

lambda

)

A function for creation event handler.

Since

v.5.6.0

Definition at line 243 of file handler_makers.hpp.

make_handler_with_arg()

template<typename Handler_Type , typename Result , typename Arg >

msg_type_and_handler_pair_t so_5::details::event_subscription_helpers::make_handler_with_arg

(

Handler_Type

lambda

)

Helper template for creation of event handler with actual argument.

Since

v.5.5.14

Definition at line 218 of file handler_makers.hpp.

make_handler_with_arg_for_agent()

template<typename Agent , typename Method_Pointer >

std::enable_if< is_agent_method_pointer< method_arity::unary, Method_Pointer >::value, msg_type_and_handler_pair_t >::type so_5::details::event_subscription_helpers::make_handler_with_arg_for_agent	(	Agent *	agent,
		Method_Pointer	pfn )

Helper template for creation of event handler with actual argument.

Since

v.5.5.14

Definition at line 270 of file handler_makers.hpp.