External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-01-22 12:35:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

virDomainGetBlockJobInfo: Discourage polling for block job completion detection

Browse Source 
Add a note saying that polling virDomainGetBlockJobInfo is not a good
idea. Use events instead.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
This commit is contained in:
Peter Krempa 2020-12-04 16:07:56 +01:00 committed by Michal Privoznik
parent b0d3053a2b
commit a015b5c0a1
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/libvirt-domain.c
View File

@ -9947,6 +9947,11 @@ virDomainBlockJobAbort(virDomainPtr dom, const char *disk,
* and was no-op. In this case libvirt reports cur = 1 and end = 1.
* Since 2.3.0.
*
* Applications looking for a reliable and low-overhead way to determine whether
* a block job already finished or reached synchronised phase should register a
* handler for the VIR_DOMAIN_EVENT_ID_BLOCK_JOB_2 event instead of polling this
* API.
*
* Note that the progress reported for blockjobs corresponding to a pull-mode
* backup don't report progress of the backup but rather usage of temporary
* space required for the backup.