iPXE
Data Fields
job_progress Struct Reference

Job progress. More...

#include <job.h>

Data Fields

unsigned long completed
 Amount of operation completed so far.
unsigned long total
 Total operation size.
char message [32]
 Message (optional)

Detailed Description

Job progress.

Definition at line 15 of file job.h.


Field Documentation

unsigned long job_progress::completed

Amount of operation completed so far.

The units for this quantity are arbitrary. completed divded by should give something which approximately represents the progress through the operation. For a download operation, using byte counts would make sense.

Definition at line 23 of file job.h.

Referenced by downloader_progress(), and monojob_wait().

unsigned long job_progress::total

Total operation size.

See completed. A zero value means "total size unknown" and is explcitly permitted; users should take this into account before calculating completed/total.

Definition at line 30 of file job.h.

Referenced by downloader_progress(), and monojob_wait().

Message (optional)

Definition at line 32 of file job.h.

Referenced by dns_progress(), monojob_wait(), and peermux_progress().


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