ringbuffer::NotifyingWriter Class Reference

#include <notifying.h>

Inherits ringbuffer::AbstractWriter.

Public Member Functions
	NotifyingWriter (const WriterPtr &writer, const ccf::ds::WorkBeaconPtr &wb)
void	finish (const WriteMarker &marker) override
WriteMarker	prepare (Message m, size_t size, bool wait=true, size_t *identifier=nullptr) override
WriteMarker	write_bytes (const WriteMarker &marker, const uint8_t *bytes, size_t size) override
size_t	get_max_message_size () override
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

NotifyingWriter()

ringbuffer::NotifyingWriter::NotifyingWriter ( const WriterPtr &  writer, const ccf::ds::WorkBeaconPtr &  wb  )

inline

Member Function Documentation

finish()

void ringbuffer::NotifyingWriter::finish ( const WriteMarker &  marker )

inlineoverridevirtual

Implements ringbuffer::AbstractWriter.

get_max_message_size()

size_t ringbuffer::NotifyingWriter::get_max_message_size ( )

inlineoverridevirtual

Implements ringbuffer::AbstractWriter.

prepare()

WriteMarker ringbuffer::NotifyingWriter::prepare ( Message  m, size_t  size, bool  wait = true, 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.

write_bytes()

WriteMarker ringbuffer::NotifyingWriter::write_bytes ( const WriteMarker &  marker, const uint8_t *  bytes, size_t  size  )

inlineoverridevirtual

Implements ringbuffer::AbstractWriter.

---

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

• src/ds/notifying.h