report_mode.h File Reference

#include <pineforge/pineforge.h>

Include dependency graph for report_mode.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	pf_report_sequence_v1
	Logical cardinality and explicit capture policy for one sequence. More...
struct	pf_report_metadata_v1
	Fixed-size report metadata. More...
struct	pf_report_envelope_v1
	Opt-in envelope, not an extension of the caller-allocated ABI-4 report. More...

Macros
#define	PF_REPORT_ENVELOPE_VERSION   1
	Version of the opt-in report envelope; independent of PF_ABI_VERSION.

Typedefs
typedef uint32_t	pf_report_mode_v1_t
	Fixed-width mode word, including for consumers using short C enums.

Enumerations
enum	{   PF_REPORT_MODE_FULL = 0 ,   PF_REPORT_MODE_SUMMARY_ONLY = 1 ,   PF_REPORT_MODE_STREAMED = 2 }
enum	{   PF_REPORT_MODE_ACCEPTED = 0 ,   PF_REPORT_MODE_INVALID = -1 ,   PF_REPORT_MODE_UNSUPPORTED = -2 ,   PF_REPORT_MODE_BUSY = -3 ,   PF_REPORT_MODE_CONFLICT = -4 ,   PF_REPORT_MODE_REPLAY_UNAVAILABLE = -5 }
	Setter/read outcomes. More...

Functions
	PF_STATIC_ASSERT (sizeof(pf_report_mode_v1_t)==4)
	PF_STATIC_ASSERT (sizeof(pf_report_sequence_v1)==16)
	PF_STATIC_ASSERT (offsetof(pf_report_sequence_v1, captured)==8)
	PF_STATIC_ASSERT (offsetof(pf_report_sequence_v1, external)==12)
	PF_STATIC_ASSERT (sizeof(pf_report_metadata_v1)==128)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, trades)==16)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, equity_curve)==32)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, broker_state_hash)==48)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, trace)==64)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, trace_names)==80)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, output_rows)==96)
	PF_STATIC_ASSERT (offsetof(pf_report_metadata_v1, output_events)==112)
	PF_STATIC_ASSERT (offsetof(pf_report_envelope_v1, report)==128)
	PF_STATIC_ASSERT (sizeof(pf_report_envelope_v1)==128+sizeof(pf_report_t))

Macro Definition Documentation

PF_REPORT_ENVELOPE_VERSION

#define PF_REPORT_ENVELOPE_VERSION   1

Version of the opt-in report envelope; independent of PF_ABI_VERSION.

The legacy pf_report_t layout and all existing function signatures stay unchanged. No runtime C export is introduced by this header.

Definition at line 22 of file report_mode.h.

Typedef Documentation

pf_report_mode_v1_t

typedef uint32_t pf_report_mode_v1_t

Fixed-width mode word, including for consumers using short C enums.

Definition at line 25 of file report_mode.h.

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
PF_REPORT_MODE_FULL	Legacy owning report sequences.
PF_REPORT_MODE_SUMMARY_ONLY	FULL metric bits without presentation overrides; no captured sequences; refused with an observer, selection window or observed phase and no sink.
PF_REPORT_MODE_STREAMED	Complete sequences in an external sink.

Definition at line 26 of file report_mode.h.

anonymous enum

anonymous enum

Setter/read outcomes.

Rejection leaves configuration unchanged; invalid envelope descriptors also leave the destination unchanged.

Enumerator
PF_REPORT_MODE_ACCEPTED
PF_REPORT_MODE_INVALID
PF_REPORT_MODE_UNSUPPORTED
PF_REPORT_MODE_BUSY
PF_REPORT_MODE_CONFLICT
PF_REPORT_MODE_REPLAY_UNAVAILABLE

Definition at line 34 of file report_mode.h.

Function Documentation

PF_STATIC_ASSERT() [1/14]

PF_STATIC_ASSERT

(

sizeof(pf_report_mode_v1_t)

= =4

)

PF_STATIC_ASSERT() [2/14]

PF_STATIC_ASSERT

(

sizeof(pf_report_sequence_v1)

= =16

)

PF_STATIC_ASSERT() [3/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_sequence_v1, captured)

= =8

)

PF_STATIC_ASSERT() [4/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_sequence_v1, external)

= =12

)

PF_STATIC_ASSERT() [5/14]

PF_STATIC_ASSERT

(

sizeof(pf_report_metadata_v1)

= =128

)

PF_STATIC_ASSERT() [6/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, trades)

= =16

)

PF_STATIC_ASSERT() [7/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, equity_curve)

= =32

)

PF_STATIC_ASSERT() [8/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, broker_state_hash)

= =48

)

PF_STATIC_ASSERT() [9/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, trace)

= =64

)

PF_STATIC_ASSERT() [10/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, trace_names)

= =80

)

PF_STATIC_ASSERT() [11/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, output_rows)

= =96

)

PF_STATIC_ASSERT() [12/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_metadata_v1, output_events)

= =112

)

PF_STATIC_ASSERT() [13/14]

PF_STATIC_ASSERT

(

offsetof(pf_report_envelope_v1, report)

= =128

)

PF_STATIC_ASSERT() [14/14]

PF_STATIC_ASSERT

(

sizeof(pf_report_envelope_v1)

= =128+sizeof(pf_report_t)

)