caf::abstract_group Class Reference

A multicast group. More...

#include <abstract_group.hpp>

Inheritance diagram for caf::abstract_group:

Classes
class	module
	Interface for user-defined multicast implementations. More...

Public Types
using	module_ptr = module *
using	unique_module_ptr = std::unique_ptr< module >

Public Member Functions
virtual void	serialize (serializer *sink)=0
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...
module_ptr	get_module () const
const std::string &	module_name () const
	Returns the name of the module.
virtual bool	subscribe (const actor_addr &who)=0
	Subscribes who to this group and returns true on success or false if who is already subscribed. More...
virtual void	stop ()=0
	Stops any background actors or threads and IO handles.
Public Member Functions inherited from caf::abstract_channel
virtual void	enqueue (const actor_addr &sender, message_id mid, message content, execution_unit *host)=0
	Enqueues a new message to the channel.
virtual void	enqueue (mailbox_element_ptr what, execution_unit *host)
	Enqueues a new message wrapped in a mailbox_element to the channel. More...
node_id	node () const
	Returns the ID of the node this actor is running on.
bool	is_remote () const
	Returns true if node_ptr returns.
bool	is_abstract_actor () const
bool	is_abstract_group () const
Public Member Functions inherited from caf::ref_counted
	ref_counted (const ref_counted &)
ref_counted &	operator= (const ref_counted &)
void	ref () noexcept
	Increases reference count by one.
void	deref () 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::memory_managed
virtual void	request_deletion (bool decremented_rc) noexcept
	Default implementations calls `delete this, but can be overriden in case deletion depends on some condition or the class doesn't use default new/delete. More...

Protected Member Functions
	abstract_group (module_ptr module, std::string group_id, const node_id &nid)
virtual void	unsubscribe (const actor_addr &who)=0
Protected Member Functions inherited from caf::abstract_channel
int	flags () const
void	flags (int new_value)

Protected Attributes
module_ptr	module_
std::string	identifier_
Protected Attributes inherited from caf::ref_counted
std::atomic< size_t >	rc_

Friends
class	local_actor
class	subscription
class	detail::group_manager

Additional Inherited Members
Static Public Attributes inherited from caf::abstract_channel
static constexpr int	is_abstract_actor_flag = 0x100000
static constexpr int	is_abstract_group_flag = 0x200000
Related Functions inherited from caf::ref_counted
void	intrusive_ptr_add_ref (ref_counted *p)
void	intrusive_ptr_release (ref_counted *p)

Detailed Description

A multicast group.

Member Function Documentation

const std::string& caf::abstract_group::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 bool caf::abstract_group::subscribe ( const actor_addr &  who )

pure virtual

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

---

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

• libcaf_core/caf/abstract_group.hpp