ngen::serialization::FileBackend::Writer Class Reference

Inheritance diagram for ngen::serialization::FileBackend::Writer:

Collaboration diagram for ngen::serialization::FileBackend::Writer:

Public Member Functions
	Writer (std::shared_ptr< FileBackend > parent, Durability durability)
	~Writer () override=default
auto	write (const RecordView &rec) -> expected< void, BackendError > override
	Append a record to this checkpoint event.
auto	commit () -> expected< void, BackendError > override
	Commit the event: flush pending writes, make them durable (under Durability::strict), surface deferred errors, run any collective barriers the backend requires.

Private Attributes
std::shared_ptr< FileBackend >	parent_
Durability	durability_

Constructor & Destructor Documentation

Writer()

ngen::serialization::FileBackend::Writer::Writer ( std::shared_ptr< FileBackend > parent, Durability durability )

inline

~Writer()

ngen::serialization::FileBackend::Writer::~Writer ( )

overridevirtualdefault

Reimplemented from ngen::serialization::RecordBackend::Writer.

Member Function Documentation

commit()

auto ngen::serialization::FileBackend::Writer::commit ( ) -> expected< void, BackendError >

inlineoverridevirtual

Commit the event: flush pending writes, make them durable (under Durability::strict), surface deferred errors, run any collective barriers the backend requires.

With Durability::relaxed, durability is best-effort and errors may not surface until the parent backend's finalize() call.

Implements ngen::serialization::RecordBackend::Writer.

References durability_, parent_, and ngen::serialization::strict.

write()

auto ngen::serialization::FileBackend::Writer::write ( const RecordView & rv ) -> expected< void, BackendError >

inlineoverridevirtual

Append a record to this checkpoint event.

The caller owns the RecordView's payload bytes for the duration of this call; the writer streams them to storage and does not retain the pointer after returning. Error arm carries a backend-specific diagnostic if the append fails (I/O error, oversized payload, etc.).

Implements ngen::serialization::RecordBackend::Writer.

References models::bmi::protocols::serialization::wire_format::RecordPrefix::checkpoint_epoch, models::bmi::protocols::serialization::wire_format::encode_record_prefix(), models::bmi::protocols::serialization::wire_format::RecordPrefix::id_length, models::bmi::protocols::MAX_RECORD_PAYLOAD_BYTES, parent_, models::bmi::protocols::serialization::wire_format::RecordPrefix::payload_length, models::bmi::protocols::serialization::wire_format::RecordPrefix::simulation_timestamp, models::bmi::protocols::serialization::wire_format::RecordPrefix::time_step, and models::bmi::protocols::write_record().

Member Data Documentation

durability_

Durability ngen::serialization::FileBackend::Writer::durability_

private

Referenced by commit().

parent_

std::shared_ptr<FileBackend> ngen::serialization::FileBackend::Writer::parent_

private

Referenced by commit(), and write().

---

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

• src/utilities/bmi/file_backend.cpp