FluxCaptureRecord Struct Reference

Internal structure for storing flux capture data during write mode. More...

#include <aaruformat/structs/flux.h>

Data Fields
FluxEntry	entry
	Flux entry metadata describing this capture.
uint8_t *	data_buffer
	Pointer to the flux data buffer. Owned by the utarray, freed automatically.
uint32_t	data_length
	Length of the data buffer in bytes.
uint8_t *	index_buffer
	Pointer to the flux index buffer. Owned by the utarray, freed automatically.
uint32_t	index_length
	Length of the index buffer in bytes.

Detailed Description

Internal structure for storing flux capture data during write mode.

This structure is used internally by the library to store flux capture data in memory before it is written to the image. It combines the FluxEntry metadata with pointers to the actual data and index buffers.

The structure is stored in a utarray (ctx->flux_captures) during write mode, and the buffers are freed automatically when the record is removed from the array or when the array is freed.

Note

This structure is used internally and is not part of the public API.

The data_buffer and index_buffer are owned by the utarray and are freed automatically via the flux_capture_record_dtor() destructor.

Definition at line 270 of file flux.h.

Field Documentation

data_buffer

uint8_t* FluxCaptureRecord::data_buffer

Pointer to the flux data buffer. Owned by the utarray, freed automatically.

Definition at line 273 of file flux.h.

Referenced by aaruf_write_flux_capture(), flux_capture_record_dtor(), and write_flux_capture_payload().

data_length

uint32_t FluxCaptureRecord::data_length

Length of the data buffer in bytes.

Definition at line 274 of file flux.h.

Referenced by aaruf_write_flux_capture(), and write_flux_capture_payload().

entry

FluxEntry FluxCaptureRecord::entry

Flux entry metadata describing this capture.

Definition at line 272 of file flux.h.

Referenced by aaruf_write_flux_capture(), and write_flux_capture_payload().

index_buffer

uint8_t* FluxCaptureRecord::index_buffer

Pointer to the flux index buffer. Owned by the utarray, freed automatically.

Definition at line 275 of file flux.h.

Referenced by aaruf_write_flux_capture(), flux_capture_record_dtor(), and write_flux_capture_payload().

index_length

uint32_t FluxCaptureRecord::index_length

Length of the index buffer in bytes.

Definition at line 276 of file flux.h.

Referenced by aaruf_write_flux_capture(), and write_flux_capture_payload().

---

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

• include/aaruformat/structs/flux.h