mirror of
https://gitlab.com/libvirt/libvirt.git
synced 2024-12-23 21:34:54 +03:00
qemu_domain: Document qemuDomainObjBeginJob
Provide a small comment on the function and its parameters. Signed-off-by: Michal Privoznik <mprivozn@redhat.com> Reviewed-by: John Ferlan <jferlan@redhat.com>
This commit is contained in:
parent
23f55840f5
commit
dd92df93f4
@ -6353,8 +6353,22 @@ qemuDomainJobAllowed(qemuDomainObjPrivatePtr priv, qemuDomainJob job)
|
||||
/* Give up waiting for mutex after 30 seconds */
|
||||
#define QEMU_JOB_WAIT_TIME (1000ull * 30)
|
||||
|
||||
/*
|
||||
* obj must be locked before calling
|
||||
/**
|
||||
* qemuDomainObjBeginJobInternal:
|
||||
* @driver: qemu driver
|
||||
* @obj: domain object
|
||||
* @job: qemuDomainJob to start
|
||||
* @asyncJob: qemuDomainAsyncJob to start
|
||||
*
|
||||
* Acquires job for a domain object which must be locked before
|
||||
* calling. If there's already a job running waits up to
|
||||
* QEMU_JOB_WAIT_TIME after which the functions fails reporting
|
||||
* an error.
|
||||
*
|
||||
* Returns: 0 on success,
|
||||
* -2 if unable to start job because of timeout or
|
||||
* maxQueuedJobs limit,
|
||||
* -1 otherwise.
|
||||
*/
|
||||
static int ATTRIBUTE_NONNULL(1)
|
||||
qemuDomainObjBeginJobInternal(virQEMUDriverPtr driver,
|
||||
|
Loading…
Reference in New Issue
Block a user