Implementation of the group interface for instances of this module. More...

#include <local_group_module.hpp>

Inheritance diagram for caf::detail::local_group_module::impl:

Public Types
using	super = abstract_group

using	subscriber_set = std::set< strong_actor_ptr, std::less<> >

Public Member Functions
	impl (group_module_ptr mod, std::string id, node_id origin)

	impl (group_module_ptr mod, std::string id)

bool	enqueue (strong_actor_ptr sender, message_id mid, message content, execution_unit *host) override
	Enqueues a new message without forwarding stack to the channel.

bool	subscribe (strong_actor_ptr who) override
	Subscribes `who` to this group and returns `true` on success or `false` if `who` is already subscribed.

void	unsubscribe (const actor_control_block *who) override
	Unsubscribes `who` from this group.

actor	intermediary () const noexcept override
	Returns the intermediary actor for the group if applicable.

void	stop () override
	Stops any background actors or threads and IO handles.

Public Member Functions inherited from caf::abstract_group
virtual bool	subscribe (strong_actor_ptr who)=0
	Subscribes `who` to this group and returns `true` on success or `false` if `who` is already subscribed.

virtual void	unsubscribe (const actor_control_block *who)=0
	Unsubscribes `who` from this group.

virtual void	stop ()=0
	Stops any background actors or threads and IO handles.

actor_system &	system () const noexcept
	Returns the hosting system.

group_module &	module () const noexcept
	Returns the parent module.

node_id	origin () const noexcept
	Returns the origin node of the group if applicable.

const std::string &	identifier () const
	Returns a string representation of the group identifier, e.g., "224.0.0.1" for IPv4 multicast or a user-defined string for local groups.

virtual std::string	stringify () const
	Returns a human-readable string representation of the group ID.

virtual actor	intermediary () const noexcept
	Returns the intermediary actor for the group if applicable.

Public Member Functions inherited from caf::ref_counted
	ref_counted (const ref_counted &)

ref_counted &	operator= (const ref_counted &)

void	ref () const noexcept
	Increases reference count by one.

void	deref () const noexcept
	Decreases reference count by one and calls `request_deletion` when it drops to zero.

bool	unique () const noexcept
	Queries whether there is exactly one reference.

size_t	get_reference_count () const noexcept

Public Member Functions inherited from caf::abstract_channel
virtual bool	enqueue (strong_actor_ptr sender, message_id mid, message content, execution_unit *host=nullptr)=0
	Enqueues a new message without forwarding stack to the channel.

bool	is_abstract_actor () const

bool	is_abstract_group () const

bool	is_actor_decorator () const

Public Attributes
friend	local_group_module

Protected Member Functions
template<class F >
auto	critical_section (F &&fun) const

std::pair< bool, size_t >	subscribe_impl (strong_actor_ptr who)

std::pair< bool, size_t >	unsubscribe_impl (const actor_control_block *who)

Protected Member Functions inherited from caf::abstract_group
	abstract_group (group_module_ptr mod, std::string id, node_id nid)

Protected Member Functions inherited from caf::abstract_channel
int	flags () const

void	flags (int new_value)

Protected Attributes
std::mutex	mtx_

actor	intermediary_

bool	stopped_ = false

subscriber_set	subscribers_

Protected Attributes inherited from caf::abstract_group
group_module_ptr	parent_

node_id	origin_

std::string	identifier_

Protected Attributes inherited from caf::ref_counted
std::atomic< size_t >	rc_

Additional Inherited Members
Static Public Attributes inherited from caf::abstract_channel
static constexpr int	is_abstract_actor_flag = 0x01000000

static constexpr int	is_abstract_group_flag = 0x02000000

static constexpr int	is_actor_bind_decorator_flag = 0x04000000

static constexpr int	is_actor_dot_decorator_flag = 0x08000000

static constexpr int	is_actor_decorator_mask = 0x0C000000

static constexpr int	is_hidden_flag = 0x10000000

Related Functions inherited from caf::ref_counted
template<class T , class... Ts>
intrusive_cow_ptr< T >	make_copy_on_write (Ts &&... xs)
	Constructs an object of type `T` in an `intrusive_cow_ptr`.

template<class T , class... Ts>
intrusive_ptr< T >	make_counted (Ts &&... xs)
	Constructs an object of type `T` in an `intrusive_ptr`.

void	intrusive_ptr_add_ref (const ref_counted *p)

void	intrusive_ptr_release (const ref_counted *p)

Detailed Description

Implementation of the group interface for instances of this module.

Member Function Documentation

◆ enqueue()

bool caf::detail::local_group_module::impl::enqueue	(	strong_actor_ptr	sender,
		message_id	mid,
		message	content,
		execution_unit *	host
	)

overridevirtual

Enqueues a new message without forwarding stack to the channel.

Returns: true if the message has been dispatches successful, false otherwise. In the latter case, the channel has been closed and the message has been dropped. Once this function returns false, it returns false for all future invocations.

Implements caf::abstract_channel.

◆ intermediary()

actor caf::detail::local_group_module::impl::intermediary ( ) const

overridevirtualnoexcept

Returns the intermediary actor for the group if applicable.

Reimplemented from caf::abstract_group.

◆ stop()

void caf::detail::local_group_module::impl::stop ( )

overridevirtual

Stops any background actors or threads and IO handles.

Implements caf::abstract_group.

◆ subscribe()

bool caf::detail::local_group_module::impl::subscribe ( strong_actor_ptr who )

overridevirtual

Subscribes who to this group and returns true on success or false if who is already subscribed.

Implements caf::abstract_group.

◆ subscribe_impl()

std::pair< bool, size_t > caf::detail::local_group_module::impl::subscribe_impl ( strong_actor_ptr who )

protected

Precondition: mtx_ is locked

◆ unsubscribe()

void caf::detail::local_group_module::impl::unsubscribe ( const actor_control_block * who )

overridevirtual

Unsubscribes who from this group.

Implements caf::abstract_group.

◆ unsubscribe_impl()

std::pair< bool, size_t > caf::detail::local_group_module::impl::unsubscribe_impl ( const actor_control_block * who )

protected

Precondition: mtx_ is locked

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

libcaf_core/caf/detail/local_group_module.hpp

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ enqueue()

◆ intermediary()

◆ stop()

◆ subscribe()

◆ subscribe_impl()

◆ unsubscribe()

◆ unsubscribe_impl()