Checked 64 KiB buffered path/borrowed-fd writer, with opaque state. More...

#include <report_sink_writer.hpp>

Public Member Functions
	LineWriter (const pf_report_sink_v1 &sink)
	Descriptor strings are copied, as required by 6:1307.

	LineWriter (const pf_report_sink_fd_v1 &sink)
	Adopt without duplicating/closing fd; see report_sink.h for ownership, FIFO SIGPIPE handling and sequential stream/back-pressure guarantees.

	~LineWriter ()

void	write_header (const RecordSet &records)
	Open the owned path, or validate the borrowed stream fd without creating anything, and emit, in order, schema, version, run_id, engine, records (3.7:795-809, 881-883).

void	write_e (const pf_equity_point_t &point)
	Emit ["E",time_ms,equity,open_profit] (3.7:825), in time order.

void	write_t (std::int64_t n, const pf_trade_t &trade, std::uint64_t entry_incarnation, std::int64_t close_cause, std::string_view entry_id, std::string_view exit_id, std::string_view exit_comment)
	Emit T in exactly this field order (3.7:826): n,side,entry_time, exit_time,entry_price,exit_price,qty,pnl,pnl_pct,max_runup,max_drawdown, commission,entry_bar_index,exit_bar_index,open_at_end,entry_incarnation, close_cause,entry_id,exit_id,exit_comment.

Trailer	write_trailer ()
	Emit trailer,version,counts,sha256 in that key order, version=1 (3.7:833-837).

pf_report_sink_diagnostics_v1	diagnostics () const noexcept
	Bounded provenance of the successfully emitted E/T records.

void	abandon ()
	At a completed-bar boundary, flush the last complete records and permanently abandon this stream without a trailer or a receipt.

void	write_o (std::int64_t row, std::int64_t open_ms, std::int64_t close_ms, const double *values, std::int64_t count)

void	write_v (const pf_output_event_v1_t &event, std::string_view message)

void	write_k (const double *values, std::int64_t count)

void	write_x (const pf_trace_entry_t &entry, std::string_view name)

void	write_h (std::uint64_t hash)

Detailed Description

Checked 64 KiB buffered path/borrowed-fd writer, with opaque state.

Every line is one compact JSON value plus LF, UTF-8 without BOM, at most 1 MiB including LF. No whitespace outside strings, blank lines or CR. Integers are base 10 without leading zeros/+ or exponents, within +/-(2^53-1) for i64 and 0..2^53-1 for u64; bool uses true/false; hex64 uses exactly 16 lowercase hex digits. f64/strings use the helpers above.

Lifecycle: header at run begin, records in final order, trailer only on successful fill/capture. Failure/refusal/abort leaves no valid trailer. I/O errors fail the run with the catalog code planned in DESIGN 6:1330-1332 (docker/run_failure_codes.json; 3.7:881-888). OPEN S2: DESIGN does not choose the internal C++ error transport or repeated-finalization policy; no exception type, retry or idempotence guarantee is declared here. O/V/K/X/H operations below implement the same fixed version-1 descriptors.

Definition at line 66 of file report_sink_writer.hpp.

Constructor & Destructor Documentation

◆ LineWriter() [1/2]

pineforge::report_sink::LineWriter::LineWriter ( const pf_report_sink_v1 & sink )

explicit

Descriptor strings are copied, as required by 6:1307.

This is a declaration of configuration; run-begin work belongs to write_header.

◆ LineWriter() [2/2]

pineforge::report_sink::LineWriter::LineWriter ( const pf_report_sink_fd_v1 & sink )

explicit

Adopt without duplicating/closing fd; see report_sink.h for ownership, FIFO SIGPIPE handling and sequential stream/back-pressure guarantees.

◆ ~LineWriter()

pineforge::report_sink::LineWriter::~LineWriter ( )

Member Function Documentation

◆ write_header()

void pineforge::report_sink::LineWriter::write_header ( const RecordSet & records )

Open the owned path, or validate the borrowed stream fd without creating anything, and emit, in order, schema, version, run_id, engine, records (3.7:795-809, 881-883).

schema="pf-report-sink", version=1, run_id from the descriptor (NULL => ""), engine is PINEFORGE_VERSION_STRING. Each descriptor has type,fields,types,units.

◆ write_e()

void pineforge::report_sink::LineWriter::write_e ( const pf_equity_point_t & point )

Emit ["E",time_ms,equity,open_profit] (3.7:825), in time order.

time_ms is the script-bar OPEN. Caller supplies the final presented point after hold-back; selected output is anchor + window points (3.2:490-509; 3.6:756-773). The writer does not alter the held point.

◆ write_t()

void pineforge::report_sink::LineWriter::write_t	(	std::int64_t	n,
		const pf_trade_t &	trade,
		std::uint64_t	entry_incarnation,
		std::int64_t	close_cause,
		std::string_view	entry_id,
		std::string_view	exit_id,
		std::string_view	exit_comment )

Emit T in exactly this field order (3.7:826): n,side,entry_time, exit_time,entry_price,exit_price,qty,pnl,pnl_pct,max_runup,max_drawdown, commission,entry_bar_index,exit_bar_index,open_at_end,entry_incarnation, close_cause,entry_id,exit_id,exit_comment.

n starts at 1; side is "long"/"short" from trade.is_long, open_at_end is a JSON bool. Numeric trade fields come from pf_trade_t; extra fields are the existing runtime accessors' values. Strings are consumed by the call. Caller supplies sealed rows, then final unsealed and range-end rows in report order (3.3:547-551; 3.4:639-652).

◆ write_trailer()

Trailer pineforge::report_sink::LineWriter::write_trailer ( )

Emit trailer,version,counts,sha256 in that key order, version=1 (3.7:833-837).

SHA-256 is FIPS 180-4 over every byte before the trailer, including the header and each LF; the trailer excludes itself. Flush/check writes before returning the trailer values. SHA-256 runs inside the engine with no new external dependency (3.7:881-888). No destructor-generated success trailer is promised.

◆ diagnostics()

pf_report_sink_diagnostics_v1 pineforge::report_sink::LineWriter::diagnostics ( ) const

noexcept

Bounded provenance of the successfully emitted E/T records.

Zero and incomplete until the trailer succeeds; no input or output I/O.

◆ abandon()

void pineforge::report_sink::LineWriter::abandon ( )

At a completed-bar boundary, flush the last complete records and permanently abandon this stream without a trailer or a receipt.

Does not close a borrowed fd; its owner closes it after native cleanup.

References abandon().

Referenced by abandon().

◆ write_o()

void pineforge::report_sink::LineWriter::write_o	(	std::int64_t	row,
		std::int64_t	open_ms,
		std::int64_t	close_ms,
		const double *	values,
		std::int64_t	count )

References write_o().

Referenced by write_o().

◆ write_v()

void pineforge::report_sink::LineWriter::write_v	(	const pf_output_event_v1_t &	event,
		std::string_view	message )

References write_v().

Referenced by write_v().

◆ write_k()

void pineforge::report_sink::LineWriter::write_k	(	const double *	values,
		std::int64_t	count )

References write_k().

Referenced by write_k().

◆ write_x()

void pineforge::report_sink::LineWriter::write_x	(	const pf_trace_entry_t &	entry,
		std::string_view	name )

References write_x().

Referenced by write_x().

◆ write_h()

void pineforge::report_sink::LineWriter::write_h ( std::uint64_t hash )

References write_h().

Referenced by write_h().

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

report_sink_writer.hpp

Public Member Functions