#include <non_blocking.h>

Inherits ringbuffer::AbstractWriter.

Public Member Functions
	NonBlockingWriter (const WriterPtr &writer)

virtual WriteMarker	prepare (ringbuffer::Message m, size_t total_size, bool, size_t *identifier=nullptr) override

virtual void	finish (const WriteMarker &marker) override

virtual WriteMarker	write_bytes (const WriteMarker &marker, const uint8_t *bytes, size_t size) override

size_t	get_max_message_size () override

bool	try_flush_pending ()

Public Member Functions inherited from ringbuffer::AbstractWriter
virtual	~AbstractWriter ()=default

template<typename Serializer , typename... Ts>
void	write_with (Message m, Ts &&... ts)

template<typename Serializer , typename... Ts>
bool	try_write_with (Message m, Ts &&... ts)

template<typename... Ts>
void	write (Message m, Ts &&... ts)

template<typename... Ts>
bool	try_write (Message m, Ts &&... ts)

Additional Inherited Members
Public Types inherited from ringbuffer::AbstractWriter
using	WriteMarker = std::optional< size_t >

Constructor & Destructor Documentation

◆ NonBlockingWriter()

ringbuffer::NonBlockingWriter::NonBlockingWriter ( const WriterPtr & writer )

inline

Member Function Documentation

◆ finish()

virtual void ringbuffer::NonBlockingWriter::finish ( const WriteMarker & marker )

inlineoverridevirtual

Implements ringbuffer::AbstractWriter.

◆ get_max_message_size()

size_t ringbuffer::NonBlockingWriter::get_max_message_size ( )

inlineoverridevirtual

Implements ringbuffer::AbstractWriter.

◆ prepare()

virtual WriteMarker ringbuffer::NonBlockingWriter::prepare	(	ringbuffer::Message	m,
		size_t	size,
		bool	wait,
		size_t *	identifier = `nullptr`
	)

inlineoverridevirtual

Implementation requires 3 methods - prepare, finish, and write_bytes. For each message, prepare will be called with the total message size. It should return a WriteMarker for this reservation. That WriteMarker will be passed to write_bytes, which may be called repeatedly for each part of the message. write_bytes returns an opaque WriteMarker which will be passed to the next invocation of write_bytes, to track progress. Finally, finish will be called with the WriteMarker initially returned from prepare.

Implements ringbuffer::AbstractWriter.