Provides access to a resource that operates on the granularity of binary messages. More...

#include <lower_layer.hpp>

Inheritance diagram for caf::net::lp::lower_layer:

Public Member Functions
virtual void	request_messages ()=0
	Pulls messages from the transport until calling `suspend_reading`.

virtual void	suspend_reading ()=0
	Stops reading messages until calling `request_messages`.

virtual void	begin_message ()=0
	Prepares the layer for an outgoing message, e.g., by allocating an output buffer as necessary.

virtual byte_buffer &	message_buffer ()=0
	Returns a reference to the buffer for assembling the current message.

virtual bool	end_message ()=0
	Seals and prepares a message for transfer.

Public Member Functions inherited from caf::net::generic_lower_layer
virtual multiplexer &	mpx () noexcept=0
	Returns the multiplexer instance that executes this protocol stack.

virtual bool	can_send_more () const noexcept=0
	Queries whether the output device can accept more data straight away.

virtual bool	is_reading () const noexcept=0
	Queries whether the lower layer is currently reading from its input device.

virtual void	write_later ()=0
	Triggers a write callback after the write device signals downstream capacity.

virtual void	shutdown ()=0
	Shuts down any connection or session gracefully.

virtual void	shutdown (const error &reason)
	Shuts down any connection or session du to an error.

Detailed Description

Provides access to a resource that operates on the granularity of binary messages.

Member Function Documentation

virtual void caf::net::lp::lower_layer::begin_message ( )

pure virtual

Prepares the layer for an outgoing message, e.g., by allocating an output buffer as necessary.

virtual bool caf::net::lp::lower_layer::end_message ( )

pure virtual

Seals and prepares a message for transfer.

Note: When returning false, clients must also call down.set_read_error(...) with an appropriate error code.

virtual byte_buffer & caf::net::lp::lower_layer::message_buffer ( )

pure virtual

Returns a reference to the buffer for assembling the current message.

Users may only call this function and write to the buffer between calling begin_message() and end_message().

Note: The lower layers may pre-fill the buffer, e.g., to prefix custom headers.

virtual void caf::net::lp::lower_layer::request_messages ( )

pure virtual

Pulls messages from the transport until calling suspend_reading.

virtual void caf::net::lp::lower_layer::suspend_reading ( )

pure virtual

Stops reading messages until calling request_messages.

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