caf::io::network::asio_multiplexer Class Reference

A wrapper for the boost::asio multiplexer. More...

#include <asio_multiplexer.hpp>

Inheritance diagram for caf::io::network::asio_multiplexer:

Public Member Functions
connection_handle	new_tcp_scribe (const std::string &, uint16_t) override
	Tries to connect to host on given port and returns an unbound connection handle on success. More...
void	assign_tcp_scribe (abstract_broker *, connection_handle hdl) override
	Assigns an unbound scribe identified by hdl to ptr. More...
template<class Socket >
connection_handle	add_tcp_scribe (abstract_broker *, Socket &&sock)
connection_handle	add_tcp_scribe (abstract_broker *, native_socket fd) override
	Creates a new TCP doorman from a native socket handle. More...
connection_handle	add_tcp_scribe (abstract_broker *, const std::string &host, uint16_t port) override
	Tries to connect to host h on given port and returns a new scribe managing the connection on success. More...
std::pair< accept_handle, uint16_t >	new_tcp_doorman (uint16_t p, const char *in, bool rflag) override
	Tries to create an unbound TCP doorman running port, optionally accepting only connections from IP address in. More...
void	assign_tcp_doorman (abstract_broker *, accept_handle hdl) override
	Assigns an unbound doorman identified by hdl to ptr. More...
accept_handle	add_tcp_doorman (abstract_broker *, default_socket_acceptor &&sock)
accept_handle	add_tcp_doorman (abstract_broker *, native_socket fd) override
	Creates a new TCP doorman from a native socket handle. More...
std::pair< accept_handle, uint16_t >	add_tcp_doorman (abstract_broker *, uint16_t port, const char *in, bool rflag) override
	Tries to create a new TCP doorman running on port p, optionally accepting only connections from IP address in. More...
void	dispatch_runnable (runnable_ptr ptr) override
	Implementation-specific dispatching to the multiplexer's thread.
supervisor_ptr	make_supervisor () override
	Creates a supervisor to keep the event loop running.
void	run () override
	Runs the multiplexers event loop.
boost::asio::io_service *	pimpl () override
	Retrieves a pointer to the implementation or nullptr if CAF was compiled using the default backend. More...
Public Member Functions inherited from caf::io::network::multiplexer
template<class F >
void	dispatch (F fun)
	Invokes fun in the multiplexer's event loop, calling fun() immediately when called from inside the event loop. More...
template<class F >
void	post (F fun)
	Invokes fun in the multiplexer's event loop, forcing execution to be delayed when called from inside the event loop. More...
const std::thread::id &	thread_id () const
void	thread_id (std::thread::id tid)

Friends
class	io::middleman
class	supervisor

Additional Inherited Members
Public Types inherited from caf::io::network::multiplexer
using	runnable_ptr = intrusive_ptr< runnable >
using	supervisor_ptr = std::unique_ptr< supervisor >
Static Public Member Functions inherited from caf::io::network::multiplexer
static std::unique_ptr< multiplexer >	make ()
	Creates an instance using the networking backend compiled with CAF.
Protected Attributes inherited from caf::io::network::multiplexer
std::thread::id	tid_
	Must be set by the subclass.

Detailed Description

A wrapper for the boost::asio multiplexer.

Member Function Documentation

accept_handle caf::io::network::asio_multiplexer::add_tcp_doorman ( abstract_broker *  ptr, native_socket  fd  )

overridevirtual

Creates a new TCP doorman from a native socket handle.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

std::pair< accept_handle, uint16_t > caf::io::network::asio_multiplexer::add_tcp_doorman ( abstract_broker *  ptr, uint16_t  port, const char *  in, bool  reuse_addr  )

overridevirtual

Tries to create a new TCP doorman running on port p, optionally accepting only connections from IP address in.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

connection_handle caf::io::network::asio_multiplexer::add_tcp_scribe ( abstract_broker *  ptr, native_socket  fd  )

overridevirtual

Creates a new TCP doorman from a native socket handle.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

connection_handle caf::io::network::asio_multiplexer::add_tcp_scribe ( abstract_broker *  ptr, const std::string &  host, uint16_t  port  )

overridevirtual

Tries to connect to host h on given port and returns a new scribe managing the connection on success.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

void caf::io::network::asio_multiplexer::assign_tcp_doorman ( abstract_broker *  ptr, accept_handle  hdl  )

overridevirtual

Assigns an unbound doorman identified by hdl to ptr.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

void caf::io::network::asio_multiplexer::assign_tcp_scribe ( abstract_broker *  ptr, connection_handle  hdl  )

overridevirtual

Assigns an unbound scribe identified by hdl to ptr.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

std::pair< accept_handle, uint16_t > caf::io::network::asio_multiplexer::new_tcp_doorman ( uint16_t  port, const char *  in, bool  reuse_addr  )

overridevirtual

Tries to create an unbound TCP doorman running port, optionally accepting only connections from IP address in.

Warning

Do not call from outside the multiplexer's event loop.

Implements caf::io::network::multiplexer.

connection_handle caf::io::network::asio_multiplexer::new_tcp_scribe ( const std::string &  host, uint16_t  port  )

overridevirtual

Tries to connect to host on given port and returns an unbound connection handle on success.

Implements caf::io::network::multiplexer.

boost::asio::io_service * caf::io::network::asio_multiplexer::pimpl ( )

overridevirtual

Retrieves a pointer to the implementation or nullptr if CAF was compiled using the default backend.

Reimplemented from caf::io::network::multiplexer.

---

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

• libcaf_io/caf/io/network/asio_multiplexer.hpp
• libcaf_io/caf/io/network/asio_multiplexer_impl.hpp