External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Mention the types of params in event callbacks

Browse Source 
Signed-off-by: Han Han <hhan@redhat.com>
Reviewed-by: Andrea Bolognani <abologna@redhat.com>
This commit is contained in:
Han Han 2022-01-19 12:19:36 +08:00 committed by Andrea Bolognani
parent d29d153fd9
commit fa6e29f978
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/libvirt/libvirt-domain.h
View File

@ -3281,7 +3281,7 @@ typedef enum {
* @conn: virConnect connection
* @dom: The domain on which the event occurred
* @event: The specific virDomainEventType which occurred
* @detail: event specific detail information
* @detail: event specific detail information (virDomainEvent*DetailType)
* @opaque: opaque user data
*
* A callback function to be registered, and called when a domain event occurs
@ -3783,7 +3783,7 @@ typedef enum {
* virConnectDomainEventWatchdogCallback:
* @conn: connection object
* @dom: domain on which the event occurred
* @action: action that is to be taken due to watchdog firing
* @action: action that is to be taken due to watchdog firing (virDomainEventWatchdogAction)
* @opaque: application specified data
*
* The callback signature to use when registering for an event of type
@ -3817,7 +3817,7 @@ typedef enum {
* @dom: domain on which the event occurred
* @srcPath: The host file on which the IO error occurred
* @devAlias: The guest device alias associated with the path
* @action: action that is to be taken due to the IO error
* @action: action that is to be taken due to the IO error (virDomainEventIOErrorAction)
* @opaque: application specified data
*
* The callback signature to use when registering for an event of type
@ -3836,7 +3836,7 @@ typedef void (*virConnectDomainEventIOErrorCallback)(virConnectPtr conn,
* @dom: domain on which the event occurred
* @srcPath: The host file on which the IO error occurred
* @devAlias: The guest device alias associated with the path
* @action: action that is to be taken due to the IO error
* @action: action that is to be taken due to the IO error (virDomainEventIOErrorAction)
* @reason: the cause of the IO error
* @opaque: application specified data
*
@ -3940,7 +3940,7 @@ typedef virDomainEventGraphicsSubject *virDomainEventGraphicsSubjectPtr;
* virConnectDomainEventGraphicsCallback:
* @conn: connection object
* @dom: domain on which the event occurred
* @phase: the phase of the connection
* @phase: the phase of the connection (virDomainEventGraphicsPhase)
* @local: the local server address
* @remote: the remote client address
* @authScheme: the authentication scheme activated
@ -4072,7 +4072,7 @@ typedef enum {
* @conn: connection object
* @dom: domain on which the event occurred
* @devAlias: device alias
* @reason: why the tray status was changed?
* @reason: why the tray status was changed? (virDomainEventTrayChangeReason)
* @opaque: application specified data
*
* This callback occurs when the tray of a removable device is moved.
@ -4653,7 +4653,7 @@ typedef void (*virConnectDomainEventBlockThresholdCallback)(virConnectPtr conn,
* (virDomainMemoryFailureRecipientType)
* @action: the action of hardware memory failure
* (virDomainMemoryFailureActionType)
* @flags: the flags of hardware memory failure
* @flags: the flags of hardware memory failure (virDomainMemoryFailureFlags)
* @opaque: application specified data
*
* The callback occurs when the hypervisor handles the hardware memory

2
include/libvirt/libvirt-secret.h
View File

@ -191,7 +191,7 @@ typedef enum {
* @conn: connection object
* @secret: secret on which the event occurred
* @event: The specific virSecretEventLifecycleType which occurred
* @detail: contains some details on the reason of the event.
* @detail: contains some details on the reason of the event (currently unused)
* @opaque: application specified data
*
* This callback is called when a secret lifecycle action is performed,

2
include/libvirt/libvirt-storage.h
View File

@ -489,7 +489,7 @@ typedef enum {
* @conn: connection object
* @pool: pool on which the event occurred
* @event: The specific virStoragePoolEventLifecycleType which occurred
* @detail: contains some details on the reason of the event.
* @detail: contains some details on the reason of the event (currently unused)
* @opaque: application specified data
*
* This callback is called when a pool lifecycle action is performed, like start