vircommand: Document virCommandSetSendBuffer() behaviour wrt daemonize

When virCommandSetSendBuffer() is used over a virCommand that is
(or will be) daemonized, then the command must have
VIR_EXEC_ASYNC_IO flag set no later than at virCommandRunAsync()
phase so that the thread that's doing IO is spawned and thus
buffers can be sent to the process.

Signed-off-by: Michal Privoznik <mprivozn@redhat.com>
Reviewed-by: Jonathon Jongsma <jjongsma@redhat.com>
This commit is contained in:
Michal Privoznik 2022-03-22 11:03:10 +01:00
parent 02b113b282
commit 0e6f75a6f1

View File

@ -1693,6 +1693,9 @@ virCommandFreeSendBuffers(virCommand *cmd)
* @buffer is always stolen regardless of the return value. This function
* doesn't raise a libvirt error, but rather propagates the error via virCommand.
* Thus callers don't need to take a special action if -1 is returned.
*
* When the @cmd is daemonized via virCommandDaemonize() remember to request
* asynchronous IO via virCommandDoAsyncIO().
*/
int
virCommandSetSendBuffer(virCommand *cmd,