C++ Actor Framework  0.18
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
caf::detail::local_group_module::impl Class Reference

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:
Inheritance graph
Collaboration diagram for caf::detail::local_group_module::impl:
Collaboration graph

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)
 
void 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. More...
 
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
actor_systemsystem () const noexcept
 Returns the hosting system.
 
group_modulemodule () 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. More...
 
virtual std::string stringify () const
 Returns a human-readable string representation of the group ID.
 
- Public Member Functions inherited from caf::ref_counted
 ref_counted (const ref_counted &)
 
ref_countedoperator= (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. More...
 
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
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
 

Detailed Description

Implementation of the group interface for instances of this module.

Member Function Documentation

◆ 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_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: