caf::io Namespace Reference

Contains all IO-related classes and functions. More...

Namespaces
	basp
	Contains all classes and functions for the Binary Actor Sytem Protocol.
	network
	Contains classes and functions used for network abstraction.

Classes
class	abstract_broker
	A broker mediates between actor systems and other components in the network. More...
class	accept_handle
	Generic handle type for managing incoming connections. More...
struct	acceptor_closed_msg
	Signalizes that a broker acceptor has been closed. More...
class	basp_broker
	A broker implementation for the Binary Actor System Protocol (BASP). More...
class	broker
	Describes a dynamically typed broker. More...
class	broker_servant
	Base class for scribe and doorman. More...
struct	connection_closed_msg
	Signalizes that a broker connection has been closed. More...
class	connection_handle
	Generic handle type for identifying connections. More...
struct	data_transferred_msg
	Signalizes that a certain amount of bytes has been written. More...
class	doorman
	Manages incoming connections. More...
class	hook
	Interface to define hooks into the IO layer. More...
class	middleman
	Manages brokers and network backends. More...
struct	new_connection_msg
	Signalizes a newly accepted connection from a broker. More...
struct	new_data_msg
	Signalizes newly arrived data for a broker. More...
class	scribe
	Manages a stream. More...

Typedefs
template<class State >
using	stateful_broker = stateful_actor< State, broker >
	Convenience template alias for declaring state-based brokers.
using	doorman_base = broker_servant< network::acceptor_manager, accept_handle, new_connection_msg >
using	middleman_actor = typed_actor< replies_to< publish_atom, uint16_t, strong_actor_ptr, std::set< std::string >, std::string, bool >::with< ok_atom, uint16_t >, replies_to< open_atom, uint16_t, std::string, bool >::with< ok_atom, uint16_t >, replies_to< connect_atom, std::string, uint16_t >::with< ok_atom, node_id, strong_actor_ptr, std::set< std::string >>, reacts_to< unpublish_atom, actor_addr, uint16_t >, reacts_to< close_atom, uint16_t >, replies_to< spawn_atom, node_id, std::string, message >::with< ok_atom, strong_actor_ptr, std::set< std::string >>, replies_to< get_atom, node_id >::with< node_id, std::string, uint16_t >>
	A message passing interface for asynchronous networking operations. More...
using	scribe_base = broker_servant< network::stream_manager, connection_handle, new_data_msg >

Enumerations
enum	receive_policy_flag {   at_least,   at_most,   exactly }

Functions
constexpr const char *	to_string (receive_policy_flag x)
std::string	to_string (const new_connection_msg &x)
std::string	to_string (const connection_closed_msg &x)

Variables
constexpr invalid_accept_handle_t	invalid_accept_handle = invalid_accept_handle_t{}
constexpr invalid_connection_handle_t	invalid_connection_handle = invalid_connection_handle_t{}

Detailed Description

Contains all IO-related classes and functions.

Typedef Documentation

using caf::io::middleman_actor = typedef typed_actor< replies_to<publish_atom, uint16_t, strong_actor_ptr, std::set<std::string>, std::string, bool> ::with<ok_atom, uint16_t>, replies_to<open_atom, uint16_t, std::string, bool> ::with<ok_atom, uint16_t>, replies_to<connect_atom, std::string, uint16_t> ::with<ok_atom, node_id, strong_actor_ptr, std::set<std::string>>, reacts_to<unpublish_atom, actor_addr, uint16_t>, reacts_to<close_atom, uint16_t>, replies_to<spawn_atom, node_id, std::string, message> ::with<ok_atom, strong_actor_ptr, std::set<std::string>>, replies_to<get_atom, node_id>::with<node_id, std::string, uint16_t>>

A message passing interface for asynchronous networking operations.

The interface implements the following pseudo code.

interface middleman_actor {

  // Establishes a new `port <-> actor` mapping and  returns the actual
  // port in use on success. Passing 0 as port instructs the OS to choose
  // the next high-level port available for binding.
  // port: Unused TCP port or 0 for any.
  // whom: Actor that should be published at given port.
  // ifs: Interface of given actor.
  // addr: IP address to listen to or empty for any.
  // reuse:_addr: Enables or disables SO_REUSEPORT option.
  (publish_atom, uint16_t port, strong_actor_ptr whom,
   set<string> ifs, string addr, bool reuse_addr)
  -> either (ok_atom, uint16_t port)
     or     (error_atom, string error_string)

  // Opens a new port other CAF instances can connect to. The
  // difference between `PUBLISH` and `OPEN` is that no actor is mapped to
  // this port, meaning that connecting nodes only get a valid `node_id`
  // handle when connecting.
  // port: Unused TCP port or 0 for any.
  // addr: IP address to listen to or empty for any.
  // reuse:_addr: Enables or disables SO_REUSEPORT option.
  (open_atom, uint16_t port, string addr, bool reuse_addr)
  -> either (ok_atom, uint16_t port)
     or     (error_atom, string error_string)

  // Queries a remote node and returns an ID to this node as well as
  // an `strong_actor_ptr` to a remote actor if an actor was published at this
  // port. The actor address must be cast to either `actor` or
  // `typed_actor` using `actor_cast` after validating `ifs`.
  // hostname: IP address or DNS hostname.
  // port: TCP port.
  (connect_atom, string hostname, uint16_t port)
  -> either (ok_atom, node_id nid, strong_actor_ptr remote_actor, set<string> ifs)
     or     (error_atom, string error_string)

  // Closes `port` if it is mapped to `whom`.
  // whom: A published actor.
  // port: Used TCP port.
  (unpublish_atom, strong_actor_ptr whom, uint16_t port)
  -> either (ok_atom)
     or     (error_atom, string error_string)

  // Unconditionally closes `port`, removing any actor
  // published at this port.
  // port: Used TCP port.
  (close_atom, uint16_t port)
  -> either (ok_atom)
     or     (error_atom, string error_string)

  // Spawns an actor on a remote node, initializing it using the arguments
  // stored in `msg` and returns the address of the spawned actor and its
  // interface description on success; an error string otherwise.
  // nid: ID of the remote node that should spawn the actor.
  // name: Announced type name of the actor.
  // args: Initialization arguments for the actor.
  (spawn_atom, node_id nid, string name, message args)
  -> either (ok_atom, strong_actor_ptr, set<string>
     or     (error_atom, string error_string)

}