caf::io::network::scribe_impl Class Reference

Default scribe implementation. More...

#include <scribe_impl.hpp>

Inheritance diagram for caf::io::network::scribe_impl:

Public Member Functions
	scribe_impl (default_multiplexer &mx, native_socket sockfd)
void	configure_read (receive_policy::config config) override
	Implicitly starts the read loop on first call.
void	ack_writes (bool enable) override
	Enables or disables write notifications.
byte_buffer &	wr_buf () override
	Returns the current output buffer.
byte_buffer &	rd_buf () override
	Returns the current input buffer.
void	graceful_shutdown () override
void	flush () override
	Flushes the output buffer, i.e., sends the content of the buffer via the network.
std::string	addr () const override
uint16_t	port () const override
void	launch ()
void	add_to_loop () override
void	remove_from_loop () override
Public Member Functions inherited from caf::io::scribe
	scribe (connection_handle conn_hdl)
virtual void	configure_read (receive_policy::config config)=0
	Implicitly starts the read loop on first call.
virtual void	ack_writes (bool enable)=0
	Enables or disables write notifications.
virtual byte_buffer &	wr_buf ()=0
	Returns the current output buffer.
virtual byte_buffer &	rd_buf ()=0
	Returns the current input buffer.
virtual void	flush ()=0
	Flushes the output buffer, i.e., sends the content of the buffer via the network.
bool	consume (execution_unit *, const void *, size_t) override
void	data_transferred (execution_unit *, size_t, size_t) override
Public Member Functions inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
	broker_servant (handle_type x)
handle_type	hdl () const
void	halt ()
void	trigger ()
void	trigger (size_t num)
std::optional< size_t >	activity_tokens () const

Protected Attributes
bool	launched_
stream_impl< policy::tcp >	stream_
Protected Attributes inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
handle_type	hdl_
mailbox_element	value_
std::optional< size_t >	activity_tokens_

Additional Inherited Members
Public Types inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
using	handle_type = Handle
Protected Member Functions inherited from caf::io::scribe
message	detach_message () override
Protected Member Functions inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
void	detach_from (abstract_broker *ptr) override
void	invoke_mailbox_element_impl (execution_unit *ctx, mailbox_element &x)
bool	invoke_mailbox_element (execution_unit *ctx)
SysMsgType &	msg ()

Detailed Description

Default scribe implementation.

Member Function Documentation

ack_writes()

void caf::io::network::scribe_impl::ack_writes ( bool  enable )

overridevirtual

Enables or disables write notifications.

Implements caf::io::scribe.

configure_read()

void caf::io::network::scribe_impl::configure_read ( receive_policy::config  config )

overridevirtual

Implicitly starts the read loop on first call.

Implements caf::io::scribe.

flush()

void caf::io::network::scribe_impl::flush ( )

overridevirtual

Flushes the output buffer, i.e., sends the content of the buffer via the network.

Implements caf::io::scribe.

rd_buf()

byte_buffer & caf::io::network::scribe_impl::rd_buf ( )

overridevirtual

Returns the current input buffer.

Implements caf::io::scribe.

wr_buf()

byte_buffer & caf::io::network::scribe_impl::wr_buf ( )

overridevirtual

Returns the current output buffer.

Implements caf::io::scribe.

---

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

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