mdl_fetch_progress_t Struct Reference

One per-page progress event the run emits through mdl_progress_fn. More...

#include <mdl_fetch.h>

Data Fields
size_t	chapter_index
	1-based chapter position in the run.
size_t	chapter_total
	Total chapters in the run.
const char *	chapter_id
	Chapter identifier (URL leaf).
size_t	page_index
	1-based page position within the chapter.
size_t	page_total
	Pages in the chapter.
uint64_t	page_bytes
	Bytes transferred (0 when reused).
uint32_t	elapsed_ms
	Wall time for the transfer (0 when reused).
bool	reused
	Page served from an already-held file.

Detailed Description

One per-page progress event the run emits through mdl_progress_fn.

Carries everything a redirect-safe progress line needs: where we are in the run (chapter index/total), where we are in the chapter (page index/total), and how the page went (bytes and wall time, or a reuse flag). Rate is bytes over elapsed_ms; the sink formats it.

Invariant

page_bytes == 0 and elapsed_ms == 0 when reused is true.

See also

mdl_progress_fn

Since

0.1.0

Definition at line 125 of file mdl_fetch.h.

Field Documentation

chapter_id

const char* mdl_fetch_progress_t::chapter_id

Chapter identifier (URL leaf).

Definition at line 128 of file mdl_fetch.h.

Referenced by internal_report_position().

chapter_index

size_t mdl_fetch_progress_t::chapter_index

1-based chapter position in the run.

Definition at line 126 of file mdl_fetch.h.

Referenced by internal_report_position().

chapter_total

size_t mdl_fetch_progress_t::chapter_total

Total chapters in the run.

Definition at line 127 of file mdl_fetch.h.

Referenced by internal_report_position().

elapsed_ms

uint32_t mdl_fetch_progress_t::elapsed_ms

Wall time for the transfer (0 when reused).

Definition at line 132 of file mdl_fetch.h.

Referenced by mdl_report_progress(), and mdl_report_progress_bar().

page_bytes

uint64_t mdl_fetch_progress_t::page_bytes

Bytes transferred (0 when reused).

Definition at line 131 of file mdl_fetch.h.

Referenced by mdl_report_progress(), and mdl_report_progress_bar().

page_index

size_t mdl_fetch_progress_t::page_index

1-based page position within the chapter.

Definition at line 129 of file mdl_fetch.h.

Referenced by internal_report_position(), and mdl_report_progress_bar().

page_total

size_t mdl_fetch_progress_t::page_total

Pages in the chapter.

Definition at line 130 of file mdl_fetch.h.

Referenced by internal_report_position(), and mdl_report_progress_bar().

reused

bool mdl_fetch_progress_t::reused

Page served from an already-held file.

Definition at line 133 of file mdl_fetch.h.

Referenced by mdl_report_progress(), and mdl_report_progress_bar().

---

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

• apps/shared_libs/mdl/inc/mdl_fetch.h