Manages a stream. More...

#include <scribe.hpp>

Inheritance diagram for caf::io::scribe:

Public Member Functions
	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 (scheduler , const void , size_t) override

void	data_transferred (scheduler *, 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 Member Functions
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 (scheduler *ctx, mailbox_element &x)

bool	invoke_mailbox_element (scheduler *ctx)

SysMsgType &	msg ()

Additional Inherited Members
Public Types inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
using	handle_type = Handle

Protected Attributes inherited from caf::io::broker_servant< Base, Handle, SysMsgType >
handle_type	hdl_

mailbox_element	value_

std::optional< size_t >	activity_tokens_

Detailed Description

Manages a stream.

Member Function Documentation

virtual void caf::io::scribe::ack_writes ( bool enable )

pure virtual

Enables or disables write notifications.

virtual void caf::io::scribe::configure_read ( receive_policy::config config )

pure virtual

Implicitly starts the read loop on first call.

virtual void caf::io::scribe::flush ( )

pure virtual

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

virtual byte_buffer & caf::io::scribe::rd_buf ( )

pure virtual

Returns the current input buffer.

virtual byte_buffer & caf::io::scribe::wr_buf ( )

pure virtual

Returns the current output buffer.

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