FSEG-SPI
FLAM Segment Store Exit (FSEG) Service Provider Interface (SPI) Version: 5.2.1-42969
FsegCls Struct Reference

Parameters for FSEG_FUNC_CLS. More...

#include <FSEG.h>

Data Fields

unsigned int isCommit
 [INPUT] 1 = commit writes; 0 = rollback / abort.
unsigned int uiPad0
 [DUMMY] Alignment pad; set to 0.
unsigned long long uiTotalBytesWritten
 [OUTPUT] Total bytes written to the backing store (segment payloads plus any format overhead such as headers and indices). Providers that do not track this must leave it at 0 (SEGSSE zero-initialises the whole TuFsegPar union before the call).
unsigned long long uiSegmentBytesWritten
 [OUTPUT] Pure segment payload bytes written (sum of all segment data lengths passed to PUT, without format overhead). The difference uiTotalBytesWritten - uiSegmentBytesWritten is reported as FLAM.ARC.SEG.STO.OVERHEAD.WRITTEN.

Detailed Description

Parameters for FSEG_FUNC_CLS.

The driver sets isCommit before the call. The provider fills the output byte-count fields so SEGSSE can expose them as SegmentStore statistics (enabling FLMSTO to compute and log the overhead). Deletion of the archive is handled by FSEG_FUNC_DAR, not by CLS.

Field Documentation

◆ isCommit

unsigned int FsegCls::isCommit

[INPUT] 1 = commit writes; 0 = rollback / abort.

◆ uiPad0

unsigned int FsegCls::uiPad0

[DUMMY] Alignment pad; set to 0.

◆ uiSegmentBytesWritten

unsigned long long FsegCls::uiSegmentBytesWritten

[OUTPUT] Pure segment payload bytes written (sum of all segment data lengths passed to PUT, without format overhead). The difference uiTotalBytesWritten - uiSegmentBytesWritten is reported as FLAM.ARC.SEG.STO.OVERHEAD.WRITTEN.

◆ uiTotalBytesWritten

unsigned long long FsegCls::uiTotalBytesWritten

[OUTPUT] Total bytes written to the backing store (segment payloads plus any format overhead such as headers and indices). Providers that do not track this must leave it at 0 (SEGSSE zero-initialises the whole TuFsegPar union before the call).


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