libvirt/src/util
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
..
iohelper.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
keymaps.csv
viralloc.c Fix reporting of errors in OOM injection code 2013-09-24 10:52:26 +01:00
viralloc.h viralloc.h: Fix typo in VIR_APPEND_ELEMENT_COPY_QUIT 2013-10-18 15:50:31 +02:00
virarch.c Add support for detecting PPC little endian arches 2013-10-16 12:40:35 +01:00
virarch.h Add support for detecting PPC little endian arches 2013-10-16 12:40:35 +01:00
viratomic.c
viratomic.h
viraudit.c virutil: Move string related functions to virstring.c 2013-05-02 16:56:55 +02:00
viraudit.h
virauth.c Remove all direct use of getenv 2013-10-21 14:03:52 +01:00
virauth.h virAuth: Don't require virConnectPtr to retrieve authentication creds 2013-07-12 09:22:38 +02:00
virauthconfig.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virauthconfig.h
virbitmap.c virBitmapParse: Fix behavior in case of error and fix up callers 2013-08-22 11:38:36 +02:00
virbitmap.h util: Add a helper to check if all bits of a bitmap are clear 2013-04-06 10:14:21 +08:00
virbuffer.c maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virbuffer.h maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
vircgroup.c cgroups: Redefine what "unlimited" means wrt memory limits 2013-12-10 08:38:46 +01:00
vircgroup.h cgroup: Move [qemu|lxc]GetCpuBWStatus to vicgroup.c and refactor it 2013-09-16 11:32:49 +02:00
vircgrouppriv.h Track symlinks for co-mounted cgroup controllers 2013-04-15 17:35:32 +01:00
virclosecallbacks.c lxc: switch to virCloseCallbacks API 2013-07-18 14:16:54 +02:00
virclosecallbacks.h lxc: switch to virCloseCallbacks API 2013-07-18 14:16:54 +02:00
vircommand.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
vircommand.h Make virCommand env handling robust in setuid env 2013-10-21 14:03:52 +01:00
virconf.c Fix leak of comment string if virConfAddEntry fails on OOM 2013-09-25 18:12:09 +01:00
virconf.h
virdbus.c Fix race leading to crash when setting up dbus watches 2013-12-18 16:59:02 +00:00
virdbus.h Add a method for closing the dbus system bus connection 2013-10-14 10:31:01 +01:00
virdbuspriv.h Introduce virDBusCallMethod & virDBusMessageRead methods 2013-07-22 13:09:58 +01:00
virdnsmasq.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virdnsmasq.h
virebtables.c maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virebtables.h maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virendian.h
virerror.c virerror: s/VIR_ERR_STORAGE_VOL_EXISTS/VIR_ERR_STORAGE_VOL_EXISTS/ 2013-10-07 19:21:47 +02:00
virerror.h maint: fix typo in error message 2013-12-27 14:30:25 -07:00
virevent.c event: improve public API docs 2014-01-02 07:29:54 -07:00
virevent.h
vireventpoll.c event: Make debug message match function comments 2013-09-27 11:16:35 -05:00
vireventpoll.h
virfile.c Fix bug in identifying sub-mounts 2013-11-28 11:49:01 +00:00
virfile.h Pull lxcContainerGetSubtree out into shared virfile module 2013-11-28 11:49:01 +00:00
virhash.c maint: avoid 'const fooPtr' in hashes 2013-10-14 11:40:24 -06:00
virhash.h maint: avoid 'const fooPtr' in hashes 2013-10-14 11:40:24 -06:00
virhashcode.c
virhashcode.h
virhook.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virhook.h virutil: Move string related functions to virstring.c 2013-05-02 16:56:55 +02:00
viridentity.c Remove (nearly) all use of getuid()/getgid() 2013-10-21 14:03:52 +01:00
viridentity.h Also store user & group ID values in virIdentity 2013-09-18 15:04:27 +01:00
virinitctl.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virinitctl.h
viriptables.c util: use -w flag when calling iptables 2013-11-08 12:48:25 +02:00
viriptables.h util/viriptables: add/remove rules that short-circuit masquerading 2013-09-25 08:24:09 -04:00
virjson.c Remove redundant braces 2013-11-20 12:35:47 +01:00
virjson.h json: support removing a value from an object 2013-05-13 15:15:54 -06:00
virkeycode-mapgen.py virkeycode: Allow ANSI_A 2013-12-24 17:36:47 +01:00
virkeycode.c virkeycode: Allow ANSI_A 2013-12-24 17:36:47 +01:00
virkeycode.h cleanup: Don't include libvirt/libvirt.h 2013-04-17 15:50:53 +08:00
virkeyfile.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virkeyfile.h
virlockspace.c Fix leak in virLockSpaceResourceFree 2013-09-25 18:12:09 +01:00
virlockspace.h
virlog.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virlog.h Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virmacaddr.c maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virmacaddr.h maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virnetdev.c util: use size_t instead of unsigned int for num_virtual_functions 2013-11-08 14:31:11 +02:00
virnetdev.h util: use size_t instead of unsigned int for num_virtual_functions 2013-11-08 14:31:11 +02:00
virnetdevbandwidth.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virnetdevbandwidth.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevbridge.c build: fix build with latest rawhide kernel headers 2013-09-16 09:24:12 -06:00
virnetdevbridge.h
virnetdevmacvlan.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virnetdevmacvlan.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevopenvswitch.c maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevopenvswitch.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevtap.c maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevtap.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevveth.c Free cmd in virNetDevVethCreate 2013-10-04 12:03:19 +01:00
virnetdevveth.h
virnetdevvlan.c maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevvlan.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetdevvportprofile.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virnetdevvportprofile.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnetlink.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virnetlink.h maint: avoid 'const fooPtr' in virnet files 2013-10-14 13:05:34 -06:00
virnodesuspend.c Separate internal node suspend APIs from public API 2013-05-08 10:47:47 +01:00
virnodesuspend.h Separate internal node suspend APIs from public API 2013-05-08 10:47:47 +01:00
virnuma.c numa: Add wrapper of numa_node_to_cpus and use it 2013-11-04 10:50:20 +01:00
virnuma.h numa: Add wrapper of numa_node_to_cpus and use it 2013-11-04 10:50:20 +01:00
virobject.c object: require maximal alignment in base class 2013-12-13 05:59:38 -07:00
virobject.h object: require maximal alignment in base class 2013-12-13 05:59:38 -07:00
virpci.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virpci.h util: use size_t instead of unsigned int for num_virtual_functions 2013-11-08 14:31:11 +02:00
virpidfile.c virutil: Move string related functions to virstring.c 2013-05-02 16:56:55 +02:00
virpidfile.h
virportallocator.c Return -1 in virPortAllocatorAcquire if all ports are used 2013-11-18 12:28:07 +01:00
virportallocator.h Add a name to virPortAllocator 2013-11-18 12:28:02 +01:00
virprocess.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virprocess.h Include process start time when doing polkit checks 2013-05-08 10:47:45 +01:00
virrandom.c Remove all direct use of getenv 2013-10-21 14:03:52 +01:00
virrandom.h
virscsi.c virscsi: hostdev SCSI AdapterId retrieval fix 2013-09-30 15:04:46 +02:00
virscsi.h utils: Add a helper to get the device name that sg device mapped to 2013-05-16 23:50:00 +08:00
virsexpr.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virsexpr.h
virsocketaddr.c maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virsocketaddr.h maint: avoid 'const fooPtr' in several util files 2013-10-14 13:02:18 -06:00
virstatslinux.c virutil: Move string related functions to virstring.c 2013-05-02 16:56:55 +02:00
virstatslinux.h Rename stats_linux.{c,h} to virstatslinux.{c,h} 2012-12-21 11:19:48 +00:00
virstoragefile.c storage: always probe type with buffer 2013-11-06 17:31:51 -07:00
virstoragefile.h storage: always probe type with buffer 2013-11-06 17:31:51 -07:00
virstring.c Introduce standard methods for sorting strings with qsort 2013-11-28 11:29:46 +00:00
virstring.h Introduce standard methods for sorting strings with qsort 2013-11-28 11:29:46 +00:00
virsysinfo.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virsysinfo.h
virsystemd.c Don't ignore all dbus connection errors 2013-10-14 10:33:10 +01:00
virsystemd.h LXC: workaround machined uncleaned data with containers running systemd. 2013-09-30 16:47:23 +01:00
virthread.c
virthread.h build: avoid non-portable cast of pthread_t 2013-05-03 06:30:22 -06:00
virthreadpool.c virThreadPoolFree: Set n(Prio)Workers after the pool is locked 2013-12-05 15:52:23 +01:00
virthreadpool.h
virthreadpthread.c viralloc: Report OOM error on failure 2013-07-10 11:07:31 +02:00
virthreadpthread.h
virthreadwin32.c build: fix virthread build on mingw 2013-07-29 08:56:48 -06:00
virthreadwin32.h Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virtime.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virtime.h
virtpm.c Adapt to VIR_ALLOC and virAsprintf in src/util/* 2013-07-10 11:07:33 +02:00
virtpm.h Helper functions for host TPM support 2013-04-12 16:55:45 -04:00
virtypedparam.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
virtypedparam.h Introduce virTypedParamsCopy internal API 2013-06-25 00:38:25 +02:00
viruri.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
viruri.h
virusb.c maint: fix comma style issues: util 2013-11-20 09:14:55 -07:00
virusb.h
virutil.c Block all use of getenv with syntax-check 2013-10-21 14:03:52 +01:00
virutil.h Add stub getegid impl for platforms lacking it 2013-10-21 14:03:52 +01:00
viruuid.c Convert 'int i' to 'size_t i' in src/util/ files 2013-07-10 17:40:13 +01:00
viruuid.h Rename uuid.{c,h} to viruuid.{c,h} 2012-12-21 11:19:49 +00:00
virxml.c conf: allow to add XML metadata using the virDomainSetMetadata api 2013-09-17 09:42:49 +02:00
virxml.h conf: allow to add XML metadata using the virDomainSetMetadata api 2013-09-17 09:42:49 +02:00