Project Name
Version 1.0
|
Defines the progress status of a library function, allowing both progress monitoring and encoding canceling. More...
#include <jh_datatypes.h>
Data Fields | |
volatile int | cancel |
volatile float | progress |
Defines the progress status of a library function, allowing both progress monitoring and encoding canceling.
cancel
to 1. The callee is supposed to watch this variable. When the value of cancel
becomes non-zero, the callee shuts down nicely whatever it is doing.progress
must be in the range 0 to 1, indicating the percentage of the work completed by the callee. When the progress is reported to the caller, the caller is allowed to update a progress indicator. The caller is responsible for setting the correct values of the variables.cancel
must be 0. Definition at line 114 of file jh_datatypes.h.
volatile int jh_monitor_ts::cancel |
Cancel flag. If set, the execution of a library function is aborted.
Definition at line 115 of file jh_datatypes.h.
volatile float jh_monitor_ts::progress |
A library function updates this variable during execution. Valid values 0 = 0% to 1 = 100%.
Definition at line 116 of file jh_datatypes.h.