caf::io::network::multiplexer::runnable Class Reference

Simple wrapper for runnables. More...

#include <multiplexer.hpp>

Inheritance diagram for caf::io::network::multiplexer::runnable:

Public Member Functions
subtype_t	subtype () const noexcept final
	Returns a subtype hint for this object.
void	ref_resumable () const noexcept final
	Add a strong reference count to this object.
void	deref_resumable () const noexcept final
	Remove a strong reference count from this object.
Public Member Functions inherited from caf::resumable
virtual resume_result	resume (scheduler *, size_t max_throughput)=0
	Resume any pending computation until it is either finished or needs to be re-scheduled later.
Public Member Functions inherited from caf::detail::atomic_ref_counted
	atomic_ref_counted (const atomic_ref_counted &)
atomic_ref_counted &	operator= (const atomic_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
	Queries the current reference count for this object.

Additional Inherited Members
Public Types inherited from caf::resumable
enum	resume_result {   resume_later ,   awaiting_message ,   done ,   shutdown_execution_unit }
	Denotes the state in which a resumable returned from its last call to resume.
enum	subtype_t {   unspecified ,   scheduled_actor ,   io_actor ,   function_object }
	Denotes common subtypes of resumable. More...
Public Types inherited from caf::ref_counted
using	super = detail::atomic_ref_counted
Protected Attributes inherited from caf::detail::atomic_ref_counted
std::atomic< size_t >	rc_
Related Symbols 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.

Detailed Description

Simple wrapper for runnables.

Member Function Documentation

deref_resumable()

void caf::io::network::multiplexer::runnable::deref_resumable ( ) const

finalvirtualnoexcept

Remove a strong reference count from this object.

Implements caf::resumable.

ref_resumable()

void caf::io::network::multiplexer::runnable::ref_resumable ( ) const

finalvirtualnoexcept

Add a strong reference count to this object.

Implements caf::resumable.

subtype()

resumable::subtype_t caf::io::network::multiplexer::runnable::subtype ( ) const

finalvirtualnoexcept

Returns a subtype hint for this object.

This allows an execution unit to limit processing to a specific set of resumables and delegate other subtypes to dedicated workers.

Reimplemented from caf::resumable.

---

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

• libcaf_io/caf/io/network/multiplexer.hpp
• libcaf_io/caf/io/network/multiplexer.cpp