External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-07-30 21:47:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add callback-related info to virStream{Abort,Finish}

Browse Source 
When one has a non-blocking stream and aborts or finishes it without
removing the callback, any event loop invocation will trigger that
callback, but it cannot be removed any more.  We cannot remove the
callback automatically from virStream{Abort,Finish} functions due to
forward-compatibility.  So let's at least document this behaviour,
because it is not easy to find out the reason for.

Signed-off-by: Martin Kletzander <mkletzan@redhat.com>
This commit is contained in:
Martin Kletzander 2017-06-20 15:36:48 +02:00
parent fdeac7a05f
commit f1096c0247
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/libvirt-stream.c
View File

@ -1131,6 +1131,9 @@ virStreamEventRemoveCallback(virStreamPtr stream)
* errors, so if this returns a success code the application can
* be sure that all data has been successfully processed.
*
* If the stream is non-blocking, any callback must be removed
* beforehand.
*
* Returns 0 on success, -1 upon error
*/
int
@ -1170,6 +1173,9 @@ virStreamFinish(virStreamPtr stream)
* streams this can be used to inform the driver that it
* should stop sending data.
*
* If the stream is non-blocking, any callback must be removed
* beforehand.
*
* Returns 0 on success, -1 upon error
*/
int