Mercurial > archived > louis > perso > liblxcstats

comparison lxcstats.h @ 11:cff6be97dae1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a mainpage for the doxygen documentation
author Louis Opter <kalessin@kalessin.fr>
date Fri, 07 Jan 2011 20:53:10 +0100
parents 6f2e13f5fcfd
children dbf24a82f625
comparison
equal deleted inserted replaced
10:3a1977ecccc7 11:cff6be97dae1
1 #ifndef _LXC_STATS_H_ 1 #ifndef _LXC_STATS_H_
2 # define _LXC_STATS_H_ 2 # define _LXC_STATS_H_
3 3
4 # include <stdint.h> 4 # include <stdint.h>
5
6 /**
7 * @mainpage liblxcstats API Reference
8 *
9 * @section sec_about About
10 *
11 * The liblxcstats returns resources usage statistics on the LXC Containers
12 * found on your system in a convenient data structure. LXC, Linux Containers,
13 * are like chroots on steroids.
14 *
15 * LXC uses the cgroup Linux kernel feature. Unlike other software
16 * virtualization technique (such as OpenVZ), LXC works on a vanilla Linux
17 * kernel.
18 *
19 * The code assumes that the cgroup hierarchy has been created by LXC. In the
20 * future this library could become a generic cgroup statistics library.
21 *
22 * This library is used to implement the LXC plugin for Collectd.
23 *
24 * @section see_also See Also
25 *
26 * - <a href="http://lxc.sourceforge.net/">LXC Containers</a>;
27 * - <a href="http://collectd.org/">Collectd</a>.
28 */
5 29
6 /** 30 /**
7 * Opaque structure used as a context for all liblxcst functions. 31 * Opaque structure used as a context for all liblxcst functions.
8 */ 32 */
9 typedef struct _lxcst_controller lxcst_handle; 33 typedef struct _lxcst_controller lxcst_handle;