libvirt/src
Eric Blake c8f95fff63 event: improve public API docs
Since libvirt 0.9.3, the entire virevent.c file has been a public
API, so improve the documentation in this file.  Also, fix a
potential core dump - it could only be triggered by bogus use of
the API and would only affect the caller (not libvirtd), but we
might as well be nice.

* src/libvirt.c (virConnectSetKeepAlive)
(virConnectDomainEventRegister, virConnectDomainEventRegisterAny)
(virConnectNetworkEventRegisterAny): Document event loop requirement.
* src/util/virevent.c (virEventAddHandle, virEventRemoveHandle)
(virEventAddTimeout, virEventRemoveTimeout): Likewise.
(virEventUpdateHandle, virEventUpdateTimeout): Likewise, and avoid
core dump if caller didn't register handler.
(virEventRunDefaultImpl): Expand example, and set up code block in
html docs.
(virEventRegisterImpl, virEventRegisterDefaultImpl): Document more
on the use of the event loop.

Signed-off-by: Eric Blake <eblake@redhat.com>
2014-01-02 07:29:54 -07:00
..
access Avoid Coverity DEADCODE warning 2013-10-24 06:40:18 -04:00
conf domain: don't try to interpret <driver> as virtio config for hostdev interfaces 2013-12-31 10:56:21 +02:00
cpu cpu: x86: Add internal CPUID features support and KVM feature bits 2013-11-08 09:44:42 +01:00
esx src: Align make output 2013-12-04 09:41:33 +01:00
hyperv src: Align make output 2013-12-04 09:41:33 +01:00
interface interface: Take interface status into account when starting and destroying 2013-12-24 17:20:00 +01:00
libxl libxl: correctly handle affinity reset in virDomainPinVcpu[Flags] 2013-12-23 22:43:32 -07:00
locking Revert "virtlockd: treat SIGHUP like SIGUSR1" 2013-12-10 15:49:06 +01:00
lxc lxcDomainShutdownFlags: Cleanup @flags usage 2013-12-24 17:36:47 +01:00
network Add 'detail' arg to network lifecycle event internals 2013-12-13 16:07:54 +00:00
node_device maint: fix comma style issues: remaining code 2013-11-20 09:14:55 -07:00
nwfilter Remove stray semicolon after pragma macros 2013-12-19 16:02:38 +00:00
openvz maint: fix comma style issues: remaining drivers 2013-11-20 09:14:55 -07:00
parallels Renamed virDomainEventState to virObjectEventState 2013-12-10 11:35:34 +00:00
phyp Convert 'int i' to 'size_t i' in src/phyp/ files 2013-07-10 17:55:15 +01:00
qemu qemu: avoid duplicate security label restore on hostdev attach failure 2013-12-23 13:16:57 +02:00
remote event: don't overwrite registration error message 2014-01-02 05:54:53 -07:00
rpc virnetserverclient: Fix conditional change HAVE_SASL to WITH_SASL 2013-12-04 06:27:20 -05:00
secret Convert 'int i' to 'size_t i' in src/secret/ files 2013-07-10 17:40:14 +01:00
security Don't overwrite errors from virConfReadFile 2013-12-04 15:40:23 +00:00
storage storage: fix bogus target in gluster volume xml 2013-12-19 09:17:11 -07:00
test Add 'detail' arg to network lifecycle event internals 2013-12-13 16:07:54 +00:00
uml Use virObjectEventPtr instead of virDomainEventPtr 2013-12-10 12:45:21 +00:00
util event: improve public API docs 2014-01-02 07:29:54 -07:00
vbox Use virObjectEventPtr instead of virDomainEventPtr 2013-12-10 12:45:21 +00:00
vmware VMware: Do version detection earlier 2013-10-11 09:10:23 -05:00
vmx Support transient attribute on vmware disks 2013-12-17 14:24:49 -07:00
xen Use virObjectEventPtr instead of virDomainEventPtr 2013-12-10 12:45:21 +00:00
xenapi maint: fix comma style issues: xen 2013-11-20 09:14:54 -07:00
xenxs maint: fix comma style issues: xen 2013-11-20 09:14:54 -07:00
check-aclperms.pl Fix naming of permission for detecting storage pools 2013-09-12 17:20:07 +01:00
check-aclrules.pl maint: ship .pl scripts as executables 2013-11-19 14:32:59 -07:00
check-driverimpls.pl Skip virNWFilterTechDriver when validating API naming 2013-05-09 17:09:59 +01:00
check-drivername.pl Extend previous check to validate driver struct field names 2013-04-24 10:59:53 +01:00
check-symfile.pl maint: use LGPL correctly 2013-05-20 14:03:48 -06:00
check-symsorting.pl maint: use LGPL correctly 2013-05-20 14:03:48 -06:00
datatypes.c Fix crash if OOM occurs when creating virConnectPtr 2013-09-24 10:51:28 +01:00
datatypes.h Rename 'DeviceMonitor' to 'NodeDeviceDriver' 2013-04-24 10:59:53 +01:00
driver.c Remove all direct use of getenv 2013-10-21 14:03:52 +01:00
driver.h Added Network events API and virNetworkEventLifecycle. 2013-12-11 13:10:41 +00:00
dtrace2systemtap.pl
fdstream.c Always open files in binary mode in virFDStreamOpenFileInternal 2013-09-24 14:27:41 +02:00
fdstream.h Allow the iohelper path to be customized by test programs 2013-05-10 19:57:18 +01:00
gnutls_1_0_compat.h maint: don't use config.h in .h files 2013-06-05 05:53:25 -06:00
internal.h maint: use LGPL correctly 2013-05-20 14:03:48 -06:00
libvirt_atomic.syms
libvirt_daemon.syms
libvirt_driver_modules.syms
libvirt_esx.syms
libvirt_gnutls.syms
libvirt_internal.h New internal migration APIs with extensible parameters 2013-06-25 01:13:16 +02:00
libvirt_libssh2.syms
libvirt_linux.syms
libvirt_lxc.syms
libvirt_openvz.syms
libvirt_private.syms rename virBlkioDeviceWeightArrayClear to virBlkioDeviceArrayClear 2013-12-12 12:29:54 +00:00
libvirt_probes.d
libvirt_public.syms Added Network events API and virNetworkEventLifecycle. 2013-12-11 13:10:41 +00:00
libvirt_qemu_probes.d
libvirt_qemu.syms
libvirt_remote.syms build: fix build --without-remote 2013-10-04 17:01:47 -06:00
libvirt_sasl.syms
libvirt_vmware.syms VMware: Make version parsing testable and add tests 2013-09-20 08:23:31 -05:00
libvirt_vmx.syms VMX: Create virVMXFormatDisk() from HD and CD-ROM 2013-09-01 23:11:50 -05:00
libvirt_xenxs.syms
libvirt-lxc.c Ensure LXC/QEMU APIs set the filename for errors 2013-08-02 15:32:26 +01:00
libvirt-qemu.c Ensure LXC/QEMU APIs set the filename for errors 2013-08-02 15:32:26 +01:00
libvirt.c event: improve public API docs 2014-01-02 07:29:54 -07:00
libvirt.conf
lock_protocol-structs tests: check remaining .x files 2013-09-09 12:04:03 -06:00
lxc_monitor_protocol-structs tests: check remaining .x files 2013-09-09 12:04:03 -06:00
lxc_protocol-structs
Makefile.am Added Network events API and virNetworkEventLifecycle. 2013-12-11 13:10:41 +00:00
nodeinfo.c nodeinfo: fix build on non-Linux 2013-11-06 17:36:44 -07:00
nodeinfo.h Separate internal node device APIs from public API 2013-05-08 10:47:47 +01:00
qemu_protocol-structs Make naming of remote procedures match API names exactly 2013-04-24 10:33:10 +01:00
README
remote_protocol-structs Add network events to the remote driver 2013-12-11 13:26:25 +00:00
virkeepaliveprotocol-structs
virnetprotocol-structs

       libvirt library code README
       ===========================

The directory provides the bulk of the libvirt codebase. Everything
except for the libvirtd daemon and client tools. The build uses a
large number of libtool convenience libraries - one for each child
directory, and then links them together for the final libvirt.so,
although some bits get linked directly to libvirtd daemon instead.

The files directly in this directory are supporting the public API
entry points & data structures.

There are two core shared modules to be aware of:

 * util/  - a collection of shared APIs that can be used by any
            code. This directory is always in the include path
            for all things built

 * conf/  - APIs for parsing / manipulating all the official XML
            files used by the public API. This directory is only
            in the include path for driver implementation modules

 * vmx/   - VMware VMX config handling (used by esx/ and vmware/)


Then there are the hypervisor implementations:

 * esx/          - VMware ESX and GSX support using vSphere API over SOAP
 * hyperv/       - Microsoft Hyper-V support using WinRM
 * lxc/          - Linux Native Containers
 * openvz/       - OpenVZ containers using cli tools
 * phyp/         - IBM Power Hypervisor using CLI tools over SSH
 * qemu/         - QEMU / KVM using qemu CLI/monitor
 * remote/       - Generic libvirt native RPC client
 * test/         - A "mock" driver for testing
 * uml/          - User Mode Linux
 * vbox/         - Virtual Box using native API
 * vmware/       - VMware Workstation and Player using the vmrun tool
 * xen/          - Xen using hypercalls, XenD SEXPR & XenStore
 * xenapi/       - Xen using libxenserver


Finally some secondary drivers that are shared for several HVs.
Currently these are used by LXC, OpenVZ, QEMU, UML and Xen drivers.
The ESX, Hyper-V, Power Hypervisor, Remote, Test & VirtualBox drivers all
implement the secondary drivers directly

 * cpu/          - CPU feature management
 * interface/    - Host network interface management
 * network/      - Virtual NAT networking
 * nwfilter/     - Network traffic filtering rules
 * node_device/  - Host device enumeration
 * secret/       - Secret management
 * security/     - Mandatory access control drivers
 * storage/      - Storage management drivers


Since both the hypervisor and secondary drivers can be built as
dlopen()able modules, it is *FORBIDDEN* to have build dependencies
between these directories. Drivers are only allowed to depend on
the public API, and the internal APIs in the util/ and conf/
directories