shaba/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2025-03-20 06:50:22 +03:00
Code Releases Activity

qemuDomainObjWait: Add documentation

Browse Source 
Document why this function exists and meaning of return values.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Michal Privoznik <mprivozn@redhat.com>
This commit is contained in:
Peter Krempa 2024-06-06 18:04:57 +02:00
parent f9ad21996d
commit da8d97e4e2
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/qemu/qemu_domain.c
View File

@ -12368,6 +12368,18 @@ qemuDomainRemoveLogs(virQEMUDriver *driver,
}
/**
* qemuDomainObjWait:
* @vm: domain object
*
* Wait for a signal on the main domain condition. Take into account internal
* qemu state in addition to what virDomainObjWait checks. Code in the qemu
* driver must use this function exclusively instead of virDomainObjWait.
*
* Returns:
* 0 on successful wait AND VM is guaranteed to be running
* -1 on failure to wait or VM was terminated while waiting
*/
int
qemuDomainObjWait(virDomainObj *vm)
{