caf::net::middleman Class Reference

Provides a network backend for running protocol stacks. More...

#include <middleman.hpp>

Inheritance diagram for caf::net::middleman:

Public Types
using	void_fun_t = void (*)()
Public Types inherited from caf::actor_system_module
enum	id_t {   middleman ,   openssl_manager ,   network_manager ,   num_ids }

Public Member Functions
	middleman (actor_system &sys)
void	start () override
	Starts any background threads needed by the module.
void	stop () override
	Stops all background threads of the module.
void	init (actor_system_config &) override
	Allows the module to change the configuration of the actor system during startup.
id_t	id () const override
	Returns the identifier of this module.
void *	subtype_ptr () override
	Returns a pointer to the subtype.
actor_system &	system ()
const actor_system_config &	config () const noexcept
multiplexer &	mpx () noexcept
const multiplexer &	mpx () const noexcept
multiplexer *	mpx_ptr () const noexcept
Public Member Functions inherited from caf::actor_system_module
const char *	name () const noexcept
	Returns the human-readable name of the module.

Static Public Member Functions
static void	init_global_meta_objects ()
static actor_system::global_state_guard	init_host_system ()
	Initializes global state for the network backend by calling platform-dependent functions such as WSAStartup and ssl::startup().
static void	add_module_options (actor_system_config &cfg)
	Adds module-specific options to the config before loading the module.
static actor_system_module *	make (actor_system &sys)
	Creates a new middleman instance.
static void	check_abi_compatibility (version::abi_token token)
	Checks whether the ABI of the middleman is compatible with the CAF core.

Public Attributes
actor_system_module::id_t	id_v = actor_system_module::network_manager
	Identifies the network manager module.

Detailed Description

Provides a network backend for running protocol stacks.

Member Function Documentation

check_abi_compatibility()

void caf::net::middleman::check_abi_compatibility ( version::abi_token token )

static

Checks whether the ABI of the middleman is compatible with the CAF core.

Otherwise, calls abort.

id()

middleman::actor_system_module::id_t caf::net::middleman::id ( ) const

overridevirtual

Returns the identifier of this module.

Implements caf::actor_system_module.

init()

void caf::net::middleman::init ( actor_system_config & )

overridevirtual

Allows the module to change the configuration of the actor system during startup.

Implements caf::actor_system_module.

init_host_system()

actor_system::global_state_guard caf::net::middleman::init_host_system ( )

static

Initializes global state for the network backend by calling platform-dependent functions such as WSAStartup and ssl::startup().

Returns

a guard object shutting down the global state.

start()

void caf::net::middleman::start ( )

overridevirtual

Starts any background threads needed by the module.

Implements caf::actor_system_module.

stop()

void caf::net::middleman::stop ( )

overridevirtual

Stops all background threads of the module.

Implements caf::actor_system_module.

subtype_ptr()

void * caf::net::middleman::subtype_ptr ( )

overridevirtual

Returns a pointer to the subtype.

Implements caf::actor_system_module.

---

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

• libcaf_net/caf/net/middleman.hpp
• libcaf_net/caf/net/middleman.cpp