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

docs: event impl. registration before hypervisor connection

Browse Source 
Event implementations need to be registered before a connection to the
Hypervisor is opened, otherwise event handling can be impaired (e.g.
delayed messages). This fact is referenced in an e-mail [1], but should
also be noted in the documentation of the registration functions.

[1] https://www.redhat.com/archives/libvirt-users/2014-April/msg00011.html
This commit is contained in:
Dominik Perpeet 2015-09-25 10:54:21 +02:00 committed by Cole Robinson
parent c3d4eb124c
commit 9bf1cef737
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/util/virevent.c
View File

@ -204,6 +204,9 @@ virEventRemoveTimeout(int timer)
* to integrate with the libglib2 event loop, or libevent * to integrate with the libglib2 event loop, or libevent
* or the QT event loop. * or the QT event loop.
* *
* For proper event handling, it is important that the event implementation
* is registered before a connection to the Hypervisor is opened.
*
* Use of the virEventAddHandle() and similar APIs require that the * Use of the virEventAddHandle() and similar APIs require that the
* corresponding handler is registered. Use of the * corresponding handler is registered. Use of the
* virConnectDomainEventRegisterAny() and similar APIs requires that * virConnectDomainEventRegisterAny() and similar APIs requires that
@ -247,6 +250,9 @@ void virEventRegisterImpl(virEventAddHandleFunc addHandle,
* not have a need to integrate with an external event * not have a need to integrate with an external event
* loop impl. * loop impl.
* *
* For proper event handling, it is important that the event implementation
* is registered before a connection to the Hypervisor is opened.
*
* Once registered, the application has to invoke virEventRunDefaultImpl() in * Once registered, the application has to invoke virEventRunDefaultImpl() in
* a loop to process events. Failure to do so may result in connections being * a loop to process events. Failure to do so may result in connections being
* closed unexpectedly as a result of keepalive timeout. The default * closed unexpectedly as a result of keepalive timeout. The default